Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
shanet committed Nov 21, 2016
1 parent f6c1d41 commit 0c02e5e
Showing 1 changed file with 26 additions and 13 deletions.
39 changes: 26 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,29 +26,42 @@ RelayRemote was built and tested on an Arduino Uno with the Arduino Ethernet Shi
## Usage

### Setting up the hardware
1. Connect the Arduino ethernet shield to the Arduino by placing the ethernet shield on top of the Arduino
2. Connect a wire from the postivive terminal of the relay to a pin between 2 and 9 (inclusive) on the Arduino. Keep note of the pin you choose. Multiple relays can be connected to the same Arduino by connecting them to different pins.
3. Connect a wire from the negative terminal of the relay to a ground pin on the Arduino
4. Connect the Arduino to your network

0. Connect the Arduino ethernet shield to the Arduino by placing the ethernet shield on top of the Arduino
0. Connect a wire from the postivive terminal of the relay to a pin between 2 and 9 (inclusive) on the Arduino. Keep note of the pin you choose. Multiple relays can be connected to the same Arduino by connecting them to different pins.
0. Connect a wire from the negative terminal of the relay to a ground pin on the Arduino
0. Connect the Arduino to your network

### Installing the software
1. Change the network settings (IP, MAC, netmask, and gateway) for the Arduino by editing the server sketch (relay.pde) in the arduino folder of this repo. The lines needing changes are near the top of the file and are marked by a comment.
2. Use the Arduino software (http://arduino.cc/en/main/software) to compile and load the server sketch (relay.pde) in the arduino folder of this repo to the Arduino.
3. Repeat steps 1 and 2 for each Arduino you're setting up
4. Install the Android SDK (http://developer.android.com/sdk/index.html).
5. Either install (using the Android SDK) the pre-built APK in the android folder of this repo or import the Eclipse project in the android folder of this repo into Eclipse and use Eclipse to build and install the application to an Android device.
6. If desired, build the C client in the c_client folder of this repo on a Linux system by running `make` in a terminal.

0. Change the network settings (IP, MAC, netmask, and gateway) for the Arduino by editing the server sketch (relay.pde) in the arduino folder of this repo. The lines needing changes are near the top of the file and are marked by a comment.
0. Use the Arduino software (http://arduino.cc/en/main/software) to compile and load the server sketch (relay.pde) in the arduino folder of this repo to the Arduino.
0. Repeat steps 1 and 2 for each Arduino you're setting up
0. Install the Android SDK (http://developer.android.com/sdk/index.html).
0. Install the APK provided on the Releases page or compile it yourself (see the compiling section)
0. If desired, build the C client in the c_client folder of this repo on a Linux system by running `make` in a terminal.

### Using the Android app
1. After opening the Android app, relays must be added.
2. After adding relays, they can be added to a group, a widget can be placed on the homescreen, or an NFC tag can be created to turn the relays on/off (if the device supports NFC)

0. After opening the Android app, relays must be added.
0. After adding relays, they can be added to a group, a widget can be placed on the homescreen, or an NFC tag can be created to turn the relays on/off (if the device supports NFC)

### Using the C client
1. The C client is fairly straightforward. Run it with `--help` for more info.

0. The C client is fairly straightforward. Run it with `--help` for more info.

### Note

The default port is 2424. Don't forget to add rules to allow communcation on this port on any firewalls or gateways between the client and the server.

### Compiling

To compile the Android app yourself:

0. Install the Android SDK
0. Create `local.properties` in the `android/` directory with the following contents: `sdk.dir=/path/to/android/sdk`
0. From the `android/` directory, run `./gradlew assembleDebug` to build or `./gradlew installDebug` to build and install to attached device.

## License

Copyright (C) 2012 Shane Tully
Expand Down

0 comments on commit 0c02e5e

Please sign in to comment.