diff --git a/README.md b/README.md index d87e282..aba3da3 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,8 @@ This server has been tested with: # Instructions -The first time it boots, the board will create its own access point so you can configure the SSID and password. -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`): +The first time it boots, the board will create its own access point (`led`). +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 @@ -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. 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 @@ -27,11 +33,11 @@ Once the board is connected to your router, you can start using the API of the b * `/color?r=&g=&b=` Set * `/off` turn off the lights * `/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 * `/brightness?value=` set the brightness value (0-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 You can use a serial monitor (e.g. in the Arduino IDE) to connect to the board.