Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Adjust to current changes and cleanup
  • Loading branch information
themorlan authored Aug 24, 2020
1 parent 0608b60 commit 69be133
Showing 1 changed file with 9 additions and 24 deletions.
33 changes: 9 additions & 24 deletions components/gpio_control/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@
This service enables the control of different GPIO input & output devices for controlling the Phoniebox.
It uses to a configuration file to configure the active devices.

## How to create and run the service?
* The service can be activated during installation with the installscript.
* If the service was not activated during installation, you can alternatively use `sudo install.sh` in this folder.

## How to edit configuration files?
The configuration file is located here: `~/RPi-Jukebox-RFID/settings/gpio_settings.ini`
Editing the configuration file and restarting the service will activate the new settings.

In the following the different devices are described.
Each device can have actions which correspond to function calls.
Up to now the following input devices are implemented:
Expand All @@ -16,27 +24,4 @@ Up to now the following input devices are implemented:
it can be configured using pinA, pinB, functionCallIncr, functionCallDecr, timeBase=0.1

* **TwoButtonControl**:
This Device uses two Buttons and implements a thrid action if both buttons are pressed together.



## How to create and run the service?
* The configuration file needs to be placed in ~/.config/phoniebox/gpio_settings.ini
* The gpio_control.py needs to be started as a service. TODO

Editing the configuration file and restarting the service will activate the new settings

how to create a config file
what options can be used for what config vars
how to create tests and run them
milestones you would see for this component
often those who start something new, know best what would be nice to have and in what order.
Because while they build it, they are cutting corners :)
what is it that you think would be nice to have?

## How to edit configuration files?

### Which options do I have
The following
## Could this later be switched on and off in the web app? (see milestones below)
A nice
This Device uses two Buttons and implements a third action if both buttons are pressed together.

0 comments on commit 69be133

Please sign in to comment.