Private programming interface ============================= Pre Production Firmware ~~~~~~~~~~~~~~~~~~~~~~~ Get the Pre Production State ---------------------------- ======================== ============================== Key Value JSon ======================== ============================== Resource URL /Control/PreProd.json HTTP Method GET Response format ``application/json`` ======================== ============================== Description ^^^^^^^^^^^ This interface allow to get the State of the preproduction. Parameters ^^^^^^^^^^ None Example request ^^^^^^^^^^^^^^^ :: http://[x.x.x.x]:34000/Control/PreProd .. code-block:: json { "PreProdState": "true", "id": "/Control/PreProd.json", "status": "passed", "response_code": 200 } | | | Change the Preproduction URI State ---------------------------------- ======================== ============================== Key Value JSon ======================== ============================== Resource URL /Control/PreProd.json HTTP Method PUT | POST Response format ``application/json`` ======================== ============================== Description ^^^^^^^^^^^ This interface allow to change the preprod state. Parameters ^^^^^^^^^^ +-----+--------------------+-------------+-----------+-------------------+ | # | Name | Mandatory | Data type | Type of parameter | +=====+====================+=============+===========+===================+ | 1 | state | Yes | Boolean | GET | +-----+--------------------+-------------+-----------+-------------------+ Field details ^^^^^^^^^^^^^ :state: state could be ''true'' or ''false'' Example request ^^^^^^^^^^^^^^^ :: http://[x.x.x.x]:34000/Control/PreProd?State=[true] .. code-block:: json { "id": "/Control/PreProd.json", "status": "passed", "response_code": 200 } | | | Logger ~~~~~~ ======================== ============================== Key Value JSon ======================== ============================== Resource URL /Control/Logger.json HTTP Method PUT | POST Response format ``application/json`` ======================== ============================== Description ----------- This function modifies the logger state (ON or OFF). If the logger is activated (state set to ON), some debug logs are written in a file named “awoxlog.*.csv”. This file is stored at the root level of the USB storage plugged on the device. Parameters ---------- +-----+--------------------+-------------+-----------+-------------------+ | # | Name | Mandatory | Data type | Type of parameter | +=====+====================+=============+===========+===================+ | 1 | state | Yes | Boolean | GET | +-----+--------------------+-------------+-----------+-------------------+ Field details ^^^^^^^^^^^^^ :state: state could be ''on'' or ''off'' Example request --------------- :: http://[x.x.x.x]:34000/Control/Logger?State=[on] .. code-block:: xml passed | | | Switch Firmware ~~~~~~~~~~~~~~~ ======================== ============================== Key Value JSon ======================== ============================== Resource URL /Control/SwitchFirmware.json HTTP Method PUT | POST Response format ``application/json`` ======================== ============================== Description ----------- This function modifies the firmware of the device. Once this command has been executed, the device downloads/flashes the latest version of the specified firmware and then reboots. This function is only available for StriimLINK/QuartetII devices to be able to switch from an AWOX firmware to a another firmware familly for example. Parameters ---------- +-----+--------------------+-------------+-----------+-------------------+ | # | Name | Mandatory | Data type | Type of parameter | +=====+====================+=============+===========+===================+ | 1 | manufacturerName | Yes | String | POST | PUT | +-----+--------------------+-------------+-----------+-------------------+ | 2 | productName | Yes | String | POST | PUT | +-----+--------------------+-------------+-----------+-------------------+ | 3 | hardwareVersion | Yes | String | POST | PUT | +-----+--------------------+-------------+-----------+-------------------+ | 4 | softwareVersion | Yes | String | POST | PUT | +-----+--------------------+-------------+-----------+-------------------+ Field details ^^^^^^^^^^^^^ :manufacturerName: a Manufacturer Name :productName: a Product Name :hardwareVersion: Should contain a version as number :softwareVersion: Should contain a version as number Example request --------------- :: http://[x.x.x.x]:34000/Control/SwitchFirmware?ManufacturerName=awox&ProductName=TEST_FW&HardwareVersion=1.0&SoftwareVersion=340.0.0 .. code-block:: xml passed | | | LightService ~~~~~~~~~~~~ Get Light Service State ----------------------- ======================== ============================== Key Value JSon ======================== ============================== Resource URL /Control/LightService.json HTTP Method GET Response format ``application/json`` ======================== ============================== Description ^^^^^^^^^^^ Used to get the current Light Service State. we could get the * Current Mode * the HSV Color * the White Temperature * the White Brightness * the Status of the Light True/False for (Light ON or OFF) Parameters ^^^^^^^^^^ None. Example request ^^^^^^^^^^^^^^^ :: http://[x.x.x.x]:34000/Control/LightService .. code-block:: json { "LightState": { "HSVColor": { "-hue": 0, "-saturation": 255, "-value": 77 }, "WhiteBrightness": { "-value": 100 }, "WhiteTemperature": { "-value": 80 }, "Mode": "color", "Status": { "-value": "True" } }, "id": "/Control/LightService.json", "status": "passed", "response_code": 200 } | | | Change the Light Service State ------------------------------ ======================== ============================== Key Value JSon ======================== ============================== Resource URL /Control/LightService.json HTTP Method PUT | POST Response format ``application/json`` ======================== ============================== Description ^^^^^^^^^^^ This method allow to change parameter of the Light Service. The Mode will be automatically Change you send command of the different mode. If you send a hsv color change when you are in WHite the mode will be updated. HSV Color """"""""" +---------------+--------------------------+-------------------------------+ | Name | Minimum allowed value | Maximum allowed value | +===============+==========================+===============================+ | Hue | 0 | 359 | +---------------+--------------------------+-------------------------------+ | Saturation | 0 | 255 | +---------------+--------------------------+-------------------------------+ | Value | 0 | 255 | +---------------+--------------------------+-------------------------------+ White Temperature """"""""""""""""" +-------------------+--------------------------+-------------------------------+ | Name | Minimum allowed value | Maximum allowed value | +===================+==========================+===============================+ | White Temperature | 0 | 100 | +-------------------+--------------------------+-------------------------------+ White Brightness """""""""""""""" +-------------------+--------------------------+-------------------------------+ | Name | Minimum allowed value | Maximum allowed value | +===================+==========================+===============================+ | White Brightness | 0 | 100 | +-------------------+--------------------------+-------------------------------+ Parameters ^^^^^^^^^^ Parameters couldn't be send in the same time. if you want to update the temperature and brightness you need to send two request. +-----+--------------------+-------------+-----------+-------------------+ | # | Name | Mandatory | Data type | Type of parameter | +=====+====================+=============+===========+===================+ | 1 | mode | No | String | GET | +-----+--------------------+-------------+-----------+-------------------+ | 2 | hsvcolor | No | String | GET | +-----+--------------------+-------------+-----------+-------------------+ | 3 | white_temp | No | Integer | GET | +-----+--------------------+-------------+-----------+-------------------+ | 4 | white_bright | No | Integer | GET | +-----+--------------------+-------------+-----------+-------------------+ | 5 | cycle | No | String | GET | +-----+--------------------+-------------+-----------+-------------------+ | 6 | seq | No | String | GET | +-----+--------------------+-------------+-----------+-------------------+ | 7 | transition_duration| No | Integer | GET | +-----+--------------------+-------------+-----------+-------------------+ | 8 | step_duration | No | Integer | GET | +-----+--------------------+-------------+-----------+-------------------+ Field details """"""""""""" :mode: Color mode could be ''color'' or ''white'' :hsvcolor: HSV Color could contain a the color separated by comma. like hue,staturation,value ex: 255,95,69 :white_temp: White temperature value :white_bright: White Brightness value :cycle: Color mode could be ''flash'' or ''smooth'' :seq: Contain the list of RGB Color of the sequencein hexa :transition_duration: Duration in second of the step of the cycle :step_duration: Duration in second of the transition of the cycle Example request: ^^^^^^^^^^^^^^^^ :: http://[x.x.x.x]:34000/Control/LightService?mode=color http://[x.x.x.x]:34000/Control/LightService?hsvcolor=255,95,69 http://[x.x.x.x]:34000/Control/LightService?white_temp=20 http://[x.x.x.x]:34000/Control/LightService?white_bright=60 http://[x.x.x.x]:34000/Control/LightService?seq=ff000000ff000000ffffffffffff0000ffffff00ffffffff&cycle=flash http://[x.x.x.x]:34000/Control/LightService?transition_duration=2 http://[x.x.x.x]:34000/Control/LightService?step_duration=8 .. code-block:: xml passed | | |