Skip to content

Commit

Permalink
Update .h file (doc changes)
Browse files Browse the repository at this point in the history
  • Loading branch information
TMRh20 committed Apr 15, 2015
1 parent 342203e commit 0b8c5b2
Showing 1 changed file with 5 additions and 13 deletions.
18 changes: 5 additions & 13 deletions RF24Gateway.h
Original file line number Diff line number Diff line change
Expand Up @@ -180,19 +180,19 @@ class RF24Gateway {
/** @example bClient.sh
*
* Once RF24Gateway and RF24Ethernet are configured, standard tools can be used to interact with
* the sensor nodes. Example of on demand LED/Lighting control using a Bash script.
* the sensor nodes. <br>Example of on demand LED/Lighting control using a Bash script.
*/

/** @example nodeClient.js
*
* Once RF24Gateway and RF24Ethernet are configured, standard tools can be used to interact with
* the sensor nodes. Example of on demand LED/Lighting control using a NodeJS script.
* the sensor nodes. <br> Example of on demand LED/Lighting control using a NodeJS script.
*/

/** @example pyClient.py
*
* Once RF24Gateway and RF24Ethernet are configured, standard tools can be used to interact with
* the sensor nodes. Example of scheduled LED/Lighting control using a Python script.
* the sensor nodes. <br> Example of scheduled LED/Lighting control using a Python script.
*/

/**
Expand All @@ -207,18 +207,10 @@ class RF24Gateway {
*
* @section Installation Installation
*
* Installation instructions will be included with the RF24Ethernet documentation at http://tmrh20.github.io/RF24Ethernet once RF24Gateway
* is completed.
* Installation instructions are included with the RF24Ethernet documentation at http://tmrh20.github.io/RF24Ethernet
*
* **Current:**
*
* a: Install RF24 libs per installer. <br>
* b: Manually download/clone RF24Gateway from https://github.com/TMRh20/RF24Gateway and run 'sudo make install' <br>
* c: Edit one of the examples to specify your CE/CSN pin config ( RF24 radio(22,0); ) <br>
* d: If using the RF24GatewayNode example, edit to set your IP/Subnet information <br>
* e: 'make' and run the example file(s) <br>
*
* Note: Forwarding/NAT may need to be configured as with RF24toTUN<br>
* Note: Forwarding/NAT may need to be configured<br>
* Note: RF24Gateway is tested with and defaults to using RF24Mesh. Sensor nodes must also use RF24Mesh with the default configuration.
*
*
Expand Down

0 comments on commit 0b8c5b2

Please # to comment.