Skip to content

Commit

Permalink
Update RF24Ethernet config&setup
Browse files Browse the repository at this point in the history
- Link to new installer
- Modify commands for CMAKE
- Add commands to manually configure the interface when not running as root
- Remove step 4 for Arduino and clarify
  • Loading branch information
TMRh20 committed Jun 17, 2024
1 parent 590b307 commit 6cf3278
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions docs/config_setup.md
Original file line number Diff line number Diff line change
@@ -11,26 +11,30 @@ See [this video walk-through](https://www.youtube.com/watch?v=rBAIqAaRu0g) of th
On the Raspberry Pi, a companion program, <a href="http://nRF24.github.io/RF24Gateway/">RF24Gateway</a> must be installed along with the RF24 and RF24Network libraries
1. Enter the following to download an install script that will build and install the needed RF24* libraries:
```shell
wget http://tmrh20.github.io/RF24Installer/RPi/install.sh
wget https://raw.githubusercontent.com/nRF24/.github/main/installer/install.sh
chmod +x install.sh
./install.sh
```
2. Next, build and run the [RF24Gateway_ncurses example](https://nrf24.github.io/RF24Gateway/RF24Gateway_ncurses_8cpp-example.html)
```shell
cd RF24Gateway/examples/ncurses
cd rf24libs/RF24Gateway/examples/build
make
sudo ./RF24Gateway_ncurses
cd ncurses
./RF24Gateway_ncurses
```
3. The application will require the user to specify an IP address and Subnet Mask: 10.10.2.2 and 255.255.255.0 are the defaults with RF24Ethernet examples, but this only works when running as root. Run the following commands to configure the interface and IP, where `pi` is your username:
```shell
ip tuntap add dev tun_nrf24 mode tun user pi multi_queue
ifconfig tun_nrf24 10.10.2.2/24
```
3. The application will require the user to specify an IP address and Subnet Mask: 10.10.2.2 and 255.255.255.0 are the defaults with RF24Ethernet examples
4. Raspberry Pi defaults to the master node (00) using RF24Mesh. Secondary Raspberry pi nodes need to specify their RF24Network address or RF24Mesh nodeID.

### Arduino
1. For Arduino devices, use the Arduino Library Manager to install the RF24 libraries
2. Open the included Getting_Started_SimpleServer or Getting_Started_SimpleClient example
3. Configure your chosen CE and CS pins for the radio connection.
4. Configure the RF24Mesh nodeID (Any unique value from 3 to 255)
5. Configure the IP address according to your preferences, (last octet must==nodeID) with the gateway set to the chosen IP of the RPi.
6. Connect into your nodes web-server at `http://ip-of-your-node:1000` from the RPi or configure the client sketch to connect to a server
4. Configure the IP address according to your preferences, (last octet must == RF24Mesh nodeID) with the gateway set to the chosen IP of the RPi.
5. Connect into your nodes web-server at `http://ip-of-your-node:1000` from the RPi or configure the client sketch to connect to a server
running on the Raspberry Pi.

@note To minimize memory usage on Arduino, edit RF24Network_config.h with a text editor, and uncomment `#define DISABLE_USER_PAYLOADS`. This

0 comments on commit 6cf3278

Please sign in to comment.