Type of HTTP commandCommandVariable (x)Success ResponseFailure ResponseDescription
GET/Nonecontrol_page.htmlcontrol_page.htmlThis is a basic GET request for the shade control page. It responds with the control_page.html file.
GET/?height=xx is a positive integer 0 to 100HTTP 200 header, no message bodyHTTP 400 header, no message bodySets the shade’s desired height to the value x.
GET/?speed=xx is a positive integer 0 to 100HTTP 200 header, no message bodyHTTP 400 header, no message bodySets the shade’s speed to the value x. Note that the minimum speed of a shade is set to 70% in the firmware, so this speed value adjusts the shade’s speed between 70% and 100%.
GET/?go_upNoneHTTP 200 header, no message bodyHTTP 400 header, no message bodyCommands the shade to move upwards until “stop_up” is recieved. Used previously for temporary buttons.
GET/?stop_upNoneHTTP 200 header, no message bodyHTTP 400 header, no message bodyStops the shade from moving up. Does nothing if “go_up” was not recieved before.
GET/?go_downNoneHTTP 200 header, no message bodyHTTP 400 header, no message bodyCommands the shade to move downwards until “stop_down” is recieved. Used previously for temporary buttons.
GET/?stop_downNoneHTTP 200 header, no message bodyHTTP 400 header, no message bodyStops the shade from moving down. Does nothing if “go_down” was not recieved before.
GET/?set_topNoneHTTP 200 header, no message bodyHTTP 400 header, no message bodySets the top level for the shade. The shade must be configured in order- set_top, move to bottom, then set_bot.
GET/?set_botNoneHTTP 200 header, no message bodyHTTP 400 header, no message bodySets the bottom level for the shade. The shade must be configured in order- set_top, move to bottom, then set_bot.
GET/?resetNoneHTTP 200 header, no message bodyHTTP 400 header, no message bodyResets the top and bottom levels of the shade. The shade will move freely past its bounds until set_top and set_bot are called again. The shade must be configured in order- set_top, move to bottom, then set_bot.
GET/?shade_nameNoneshade_name only, no headerHTTP 400 header, no message bodyReturns the customer set name for the shade. This is the name that will be used for the mDNS server. Customers will control the shade from <shade_name>.local
GET/?wifi_nameNonewifi network name, no headerHTTP 400 header, no message bodyReturns the customer wifi network name. This is the wifi network that the shade will attempt to connect to.
GET/?batt_percentNonebattery percent, no headerHTTP 400 header, no message bodyReturns the calculated battery percent level.
GET/style.cssNonestyle.cssHTTP 400 header, no message bodyReturns the full style.css file used for styling the stored html pages.
GET/?powerm=xx is a positive integer 0, 1, or 2HTTP 200 header, no message bodyHTTP 400 header, no message bodySets the power mode of the device. 2 is “ALWAYS_ON,” which keeps the shade on and doesn’t allow for sleeping. This should be kept at 2 only for customers who will always have the shades plugged in. 0 and 1 both do the same thing. It allows the shade to sleep for “sleept” seconds (see below) and then wake for “waket” seconds (see below).
GET/?waket=xx is a positive integer 1 to uint32 maxHTTP 200 header, no message bodyHTTP 400 header, no message bodySets the wake interval for the device. This is the number of seconds the device will stay awake after it turns on. The shade will also wait this long before going to sleep if someone pulls the pull cord or wakes the shade in any other way.
GET/?sleept=xx is a positive integer 1 to uint32 maxHTTP 200 header, no message bodyHTTP 400 header, no message bodySets the sleep interval for the device. This is the number of seconds the device will stay asleep after it enters sleep mode. During sleep mode the shade will not respond to any HTML requests. Use this value to save battery life.
POST/client_certNoneHTTP 200 header, no message bodyHTTP 400 header, no message bodyPOST the pem file for the AWS client certificate here. The shade will wait until all three of the MQTT details are POST’ed to it before attempting a connection to the MQTT shadow. The shade will save these details only if the connection to the MQTT shadow is successful. If not, the shade will reset and need these posted again before it will attempt to connect.
POST/client_keyNoneHTTP 200 header, no message bodyHTTP 400 header, no message bodyPOST the pem file for the AWS private client key here. The shade will wait until all three of the MQTT details are POST’ed to it before attempting a connection to the MQTT shadow. The shade will save these details only if the connection to the MQTT shadow is successful. If not, the shade will reset and need these posted again before it will attempt to connect.
POST/mqtt_urlNoneHTTP 200 header, no message bodyHTTP 400 header, no message bodyPOST the mqtt_url for the desired mqtt aws shadow here. This is done in text file format.
Menu