Skip to content

Commit

Permalink
Updated README and HISTORY for new release
Browse files Browse the repository at this point in the history
  • Loading branch information
ondrej1024 committed Jan 14, 2019
1 parent ceabdee commit 16b36c5
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 5 deletions.
4 changes: 4 additions & 0 deletions HISTORY
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,7 @@ Version history
- Added monit script for crelay process supervision in daemon mode
- Added build dependencies for OpenSUSE to readme
- Added support for multiple SainSmart 16-channel HID relay cards

0.14: 13/01/2019
- Added multiple cards support to HTTP API (new "serial" parameter)
- Reworked WebGUI (replaced submit buttons with Javascript toggle switches)
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,20 +42,21 @@ The following picture shows a high level view on the modular software architectu
- HTTP API for external clients (e.g. Smartphone/tablet apps)
- Multiple relay card type support
- Support for configuration file with custom parameters
- Multiple cards support (command line interface only)
- Multiple cards support (command line interface and HTTP API)
<br>

### Nice to have (wishlist)
- Integrated MQTT client
- [ThingSpeak Talkback App](https://thingspeak.com/docs/talkback)
- Multiple cards support (Web UI / REST API)
- Multiple cards support (Web UI)
- Access control for Web GUI and HTTP API
- Programmable timers for relay actions
<br>

### Screenshots

#### Web GUI
This is the Web GUI provided by the integrated web server. The web page dynamically adapts to the detected relay card as shown.

![Screenshot](screenshots/crelay-screenshot1.png "Web GUI with Conrad card connected")
<br>
----------
Expand Down Expand Up @@ -117,7 +118,7 @@ An HTTP API is provided to access the server from external clients. This API is
Required Parameter: none

- Setting relay state
Required Parameter: <pre>pin=[1|2|3|4], status=[0|1|2] where 0=off 1=on 2=pulse</pre>
Required Parameter: <pre>pin=[1|2|3 ...], status=[0|1|2] where 0=off 1=on 2=pulse</pre>
Optional Parameter: <pre>serial=*serial_number*</pre>

- Response from server:
Expand Down Expand Up @@ -264,7 +265,7 @@ The support for the different relay cards in *crelay* has only been possible tha
* [Andrew Lunn](https://github.com/lunn), who contributed cleanup patches
* [Andrey Shevtsov](https://github.com/sqlwristband), who contributed the initial multiple cards implementation
* [Alberto Bursi](https://github.com/bobafetthotmail), who contributed documentation for OpenSUSE build support
* [Derek Atkins](https://github.com/derekatkins), who contributed multiple cards handling for the Sainsmart 16 Channel HID controller
* [Derek Atkins](https://github.com/derekatkins), who contributed multiple cards handling for the Sainsmart 16 Channel HID controller and HTTP API
<br>

### Notes
Expand Down
Binary file modified screenshots/crelay-screenshot1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshots/crelay-screenshot2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 16b36c5

Please sign in to comment.