balkian/shinesp
1
0
Fork 0
mirror of https://github.com/balkian/shinesp.git synced 2024-12-22 05:28:12 +00:00
Code Issues Releases Wiki Activity

Fixed typos

Browse Source
This commit is contained in:
J. Fernando Sánchez 2017-12-04 12:52:20 +01:00
parent 8e075a40a4
commit cdfbcdf10a
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -7,8 +7,8 @@ This server has been tested with:
# Instructions # Instructions
The first time it boots, the board will create its own access point so you can configure the SSID and password. The first time it boots, the board will create its own access point (`led`).
To configure it, just connect to the `led` network and access the board either using its IP (it is the default gateway for the network) or its MDNS name (`esp8266.local`): To configure the board, just connect to that access point and access the board either using its IP (it is the default gateway for the network) or its MDNS name (`esp8266.local`):
``` ```
curl http://esp8266.local/credentials?ssid=mywifi&pass=mypassword curl http://esp8266.local/credentials?ssid=mywifi&pass=mypassword
@ -19,6 +19,12 @@ If the credentials were correct, the `led` network should have disappeared.
If it hasn't, try rebooting the board or debugging. If it hasn't, try rebooting the board or debugging.
Once the board is connected to your router, you can start using the API of the board. Once the board is connected to your router, you can start using the API of the board.
To get the IP of the board you have several options:
* Using the MDNS address: `esp8266.local`
* Get the IP from your router's configuration page
* The board prints the IP address it was given to the serial monitor
* Use nmap/zenmap/similar
# API # API
@ -27,11 +33,11 @@ Once the board is connected to your router, you can start using the API of the b
* `/color?r=<R>&g=<G>&b=<B>` Set * `/color?r=<R>&g=<G>&b=<B>` Set
* `/off` turn off the lights * `/off` turn off the lights
* `/on` turn on the lights (using the last color and value) * `/on` turn on the lights (using the last color and value)
* `/toggle` turn the lights if they are off, and vice versa * `/toggle` turn on the lights if they are off, and vice versa
* `/white` set the color to white * `/white` set the color to white
* `/brightness?value=<VALUE>` set the brightness value (0-255) * `/brightness?value=<VALUE>` set the brightness value (0-255)
* `/brightness/up` turn up the brightness (up to 255) * `/brightness/up` turn up the brightness (up to 255)
* `/brightness/down` turn down the brightness (down to 255) * `/brightness/down` turn down the brightness (down to 0)
# Debugging # Debugging
You can use a serial monitor (e.g. in the Arduino IDE) to connect to the board. You can use a serial monitor (e.g. in the Arduino IDE) to connect to the board.