Skip to content

Commit b515afd

Browse files
committed
Docs improved.
1 parent b040425 commit b515afd

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@
77
|___\___/|_| |_||____/____/|_| |_|_| |_/___|
88

99

10+
# Summary
11+
12+
IoT System to control 433 MHz RC power sockets, PIR sensors, Door Sensors and much more.
13+
To start is required a 433mhz transmitter and receiver, a connected Arduino with the iot-433mhz sketch or directly with capable hardware like the Raspberry Pi.
14+
1015
# UI Demo
1116

1217
![iot-433mhz UI](https://github.com/roccomuso/iot-433mhz/blob/master/other/pics/web-ui.gif?raw=true "Iot-433mhz Web UI")
@@ -182,7 +187,7 @@ See the [Hardware page](https://github.com/roccomuso/iot-433mhz/tree/master/hard
182187

183188
Below every single API available is documented. Too lazy to copy and paste? just download and import the Postman collection ([download](https://github.com/roccomuso/iot-433mhz/blob/master/other/IoT-433Mhz.json.postman_collection)).
184189

185-
**Tip**: The iot-433mhz server requires a basic Authentication also for the API calls. Username and Password are defined inside the *config.json* file (default username and password: root, root).
190+
**Tip**: The iot-433mhz server requires a basic Authentication also for the API calls. Username and Password are defined inside the *config.json* file (default username and password: root, root). What you need to take into account is to set the following header field during your HTTP requests: <code>Authorization: Basic cm9vdDpyb290</code> where the last string is the base64 encoding of <code>root:root</code>, if you changed default username and password you should update the base64 text too ([learn more](https://en.wikipedia.org/wiki/Basic_access_authentication) on Basic Authentication Access).
186191

187192
- <code>GET /api/settings/get</code>
188193
Return the current settings. Useful to see notification status.

0 commit comments

Comments
 (0)