setup.html

---
title: Setup
layout: default
---

<a href="/">remoshock</a> &gt; <a href="/setup.html">Setup</a>
<h1>Setup</h1>


<h2 id="requirements"><a href="#requirements">✔️ Requirements</a></h2>

<ul>
<li> One or more compatible <a href="/receivers.html">shock collars</a>.
<li> A Software Defined Radio (SDR) transmitter that works on the required frequencies (tested using a HackRF device).
<li> Linux with Python 3 (tested on Ubuntu 20.04).
<li> Universal Radio Hacker:<br>
  <code>sudo apt install python3-pip python3-pyqt5; sudo pip3 install urh</code>
<li> <code>sudo pip3 install remoshock</code> 
  <br>Alternatively: Download <a href="https://github.com/remoshock/remoshock/releases">remoshock.zip from Github</a> manually.
<li> Please see <a href="/faq.html">FAQ</a> for troubleshooting tips.
</ul>

<h2 id="gettingstarted"><a href="#gettingstarted">🔧 Getting Started</a></h2>

<p> Make sure that <code>urh</code> is working and does recognize your SDR device.

<p> Run <code>remoshockcli</code>. This command will ask you about the number and
types of receivers in order to generate a <code>remoshock.ini</code> configuration
file. It will use random values for authentication token and transmitter
code.

<p> Reset your collar into pairing mode and invoke <code>remoshockcli</code> again.
After successful pairing, run it a third time, to issue a "beep" command.

<p> If you have more than one receiver, please repeat this step for each
device: <code>remoshockcli --receiver=1</code>, <code>remoshockcli --receiver=2</code>, etc.


<h2 id="remoshockini"><a href="#remoshockini">📝 remoshock.ini</a></h2>

<p>The file <code>remoshock.ini</code> is automatically created with random tokens and transmitter codes
when you start remoshock for the first time.


<pre>
[global]
web_port = 7777    
web_authentication_token = [random unguessable value]

# URH supports the following hardware, that can transmit on 27.195 MHz (upper/lower case is important): 
# HackRF, LimeSDR

# sdr=HackRF
</pre>

<p>The <code>[global]</code> contains general settings. <code>web_port</code> and <code>web_authentication_token</code>
are used by the web-based remote control user interface.

<p> Please configure the name of your SDR transmitter in the configuration
setting <code>sdr</code> (without the leading # in the above example).

<pre>
[receiver]
type=pac
name=PAC1
color=#FFD
transmitter_code=[random 9/16 bit value]
channel=1
limit_shock_max_power_percent=100
limit_shock_max_duration_ms=2000
</pre>


<p> Each receiver section has the following parameters:

<ul>
<li><b>name</b>: A name to display in the user interface
<li><b>color</b>: A HTML color code used by the user interface
<li><b>transmitter_code</b>: The transmitter bit code. You can use a random value of exactly 9 bits for PAC collars and 16 bits for all the other devices. Or it can be the same code as your real transmitter. Use network bit order.
<li><b>channel</b>: The channel used by the remote. For PAC it is the button number as printed on the DXT remote (top right is 1, button left is 6). In E/P-mode the left side is code 0, and the right side is code 2. Button code 7 works as well.
<li><b>limit_shock_max_power_percent</b>: Limits the maximum power level. Default: 100
<li><b>limit_shock_max_duration_ms</b>: Limits the maximum duration of a command. Default: 10000
</ul>

<p> There may be sections for the randomizer, which are documented on the <a href="/applications.html">application</a> page.

<h2 id="bugs"><a href="#bugs">🐞 Bugs and Feature Ideas</a></h2>

<p>Please report bugs and feature ideas as issues on <a href="https://github.com/remoshock/remoshock">https://github.com/remoshock/remoshock</a>.