Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated installation documentation #12

Merged
merged 2 commits into from
Aug 21, 2024
Merged

Updated installation documentation #12

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c08d681
Doc fixes
deckerego Aug 21, 2024
6b0f60d
Added configuration section
deckerego Aug 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,19 @@ Installing the sprinkler switch requires some hardware installation and installi

1. Build a relay or MOSFET switch (see the [Hackaday Project Page](https://hackaday.io/project/7566-sprinkler-switch) for details)
1. Install `apt-get install nodejs`
1. Get the latest version of SprinklerSwitch with `wget https://github.com/deckerego/Macropad_4chord_MIDI/releases/latest/download/SprinklerSwitch.zip`
1. Get the latest version of SprinklerSwitch with `wget https://github.com/deckerego/SprinklerSwitch/releases/latest/download/SprinklerSwitch.zip`
1. Unzip the latest release into a new directory: `unzip SprinklerSwitch.zip -d SprinklerSwitch`
1. Switch to the unzipped directory `cd SprinklerSwitch`
1. Run the installer script: `sudo ./install.sh`

## Configuring

Ensure you update `/etc/sprinklerswitch/config.json` to set your location using your latitude and longitude.

By default SprinklerSwitch uses the GPIO 23 pin on the Raspberry Pi to open/close the sprinkler sensor switch.
With the latest Raspian builds this maps to `gpio-535` but you can map this to any GPIO device you like by
updating `config.json`. Run `cat /sys/kernel/debug/gpio` to get a list of all GPIO pins and their device IDs.

## Testing Locally

Automated tests can be run with:
Expand Down
Loading