Skip to content

Commit

Permalink
Markup fixed.
Browse files Browse the repository at this point in the history
  • Loading branch information
rfkd authored Jan 1, 2018
1 parent 7b0928b commit 6433ae4
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
#**aircontrol**
# **aircontrol**

###**FEATURES**
### **FEATURES**

* Send configurable patterns with manchester or RCO-compatible encoding through a 433,92 MHz transmitter.
* Air scan support in combination with a 433,92 MHz receiver for analyzing data streams. This can replace an oscilloscope if timing and code scheme are already known.
* Configuration file support for easily addressing air targets.


###**INSTALLATION**
### **INSTALLATION**

aircontrol needs to be compiled on a Raspberry Pi (or on a host with a compatible cross tool chain). The following libraries are needed:

Expand All @@ -27,7 +27,7 @@ Please note that aircontrol needs to be executed as root for accessing the GPIO
hardware.


###**COMMAND LINE PARAMETERS**
### **COMMAND LINE PARAMETERS**

Execute `aircontrol -h` to see a quick overview over all available command line parameters. The following parameters are available:

Expand All @@ -44,21 +44,21 @@ Execute `aircontrol -h` to see a quick overview over all available command line
Either parameter `-s` or `-t` is mandatory.


###**CONFIGURATION FILE**
### **CONFIGURATION FILE**

The default configuration file is located in */etc/aircontrol.conf*. For details about the configuration file syntax check the manual of libconfig on its project site: <http://www.hyperrealm.com/libconfig/libconfig_manual.html>

The configuration consists of different sections explained below.

####'scan' section
#### 'scan' section

This section defines all air scan relevant parameters.

`gpioPin` &nbsp; GPIO pin of the Raspberry Pi which is connected to the DATA line of a 433,92 MHz receiver. This parameter expects Broadcom GPIO numbers, not re-mapped. Example: `gpioPin = 18;`

`samplingRate` &nbsp; Delay between two samples when air scanning in microseconds. This parameter in combination with the `-s` value defines the number of segments being output. For example when scanning for 1ms (=1000us) with a `samplingRate` of 100us there will be 10 segments printed to stdout. Example: `samplingRate = 100;`

####'target' section
#### 'target' section

This section stores configuration defaults for all target sections.

Expand Down Expand Up @@ -87,6 +87,6 @@ This section stores configuration defaults for all target sections.
___| |__| |_| |__| |_|
sss 0 1 0 0 1 1 SSS

####Actual target sections
#### Actual target sections

The actual target sections can be named freely, they incorporate all defaults from the 'target' section. All parameters from the 'target' section apply. For example all timing relevant parameters can be defined in the 'target' section while the real target sections only contain the appropriate `airCommand`.

0 comments on commit 6433ae4

Please sign in to comment.