Electronics/Stairs
Electronics/Stairs
1
0
Fork 0
Code Issues 6 Pull Requests Releases Activity

Fixed API document internal links

Browse Source
This commit is contained in:
Mark van Renswoude 2018-01-05 20:17:39 +01:00
parent 1319dd43c6
commit 488e8598ec
2 changed files with 9 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
API.md
View File

@ -1,14 +1,13 @@
# API # API
- [GET /api/version](#get-version) - [GET /api/version](#get-apiversion)
- [GET /api/connection/status](#get-connection-status) - [GET /api/connection/status](#get-apiconnectionstatus)
- [GET /api/connection](#get-connection) - [GET /api/connection](#get-apiconnection)
- [POST /api/connection](#post-connection) - [POST /api/connection](#post-apiconnection)
- [GET /api/steps](#get-steps) - [GET /api/steps](#get-apisteps)
- [POST /api/steps](#post-steps) - [POST /api/steps](#post-apisteps)
- [POST /api/firmware](#post-firmware) - [POST /api/firmware](#post-apifirmware)
<a name="get-version"></a>
## GET /api/version ## GET /api/version
Returns the unique identifier of the chip and the version of the firmware. Returns the unique identifier of the chip and the version of the firmware.
@ -21,7 +20,6 @@ Returns the unique identifier of the chip and the version of the firmware.
} }
``` ```
<a name="get-connection-status"></a>
## GET /api/connection/status ## GET /api/connection/status
Returns the status of the WiFi connections. Returns the status of the WiFi connections.
@ -43,7 +41,6 @@ The value of the 'status' element corresponds to the ```wl_status_t``` enum as d
} }
``` ```
<a name="get-connection"></a>
## GET /api/connection ## GET /api/connection
Returns the settings of the WiFi connections. Returns the settings of the WiFi connections.
@ -64,7 +61,6 @@ Returns the settings of the WiFi connections.
``` ```
<a name="post-connection"></a>
## POST /api/connection ## POST /api/connection
Updates the settings of the WiFi connections. The module will apply the new settings immediately and will break existing connections. Updates the settings of the WiFi connections. The module will apply the new settings immediately and will break existing connections.
@ -85,7 +81,6 @@ Updates the settings of the WiFi connections. The module will apply the new sett
``` ```
<a name="get-steps"></a>
## GET /api/steps ## GET /api/steps
Returns the current brightness value for each step. The number of items in the array is equal to the number of configured steps. Each value has a range of 0 to 255. Returns the current brightness value for each step. The number of items in the array is equal to the number of configured steps. Each value has a range of 0 to 255.
@ -98,7 +93,6 @@ Returns the current brightness value for each step. The number of items in the a
] ]
``` ```
<a name="post-steps"></a>
## POST /api/steps ## POST /api/steps
Changes the brightness value for each step. If the number of values in the array is less than the number of configured steps, each subsequent step is considered to be off. Changes the brightness value for each step. If the number of values in the array is less than the number of configured steps, each subsequent step is considered to be off.
@ -122,7 +116,6 @@ An optional array 'startTime' can be included which specifies the delay, for eac
} }
``` ```
<a name="post-firmware"></a>
## POST /api/firmware ## POST /api/firmware
Uploads new firmware. The bin file should be posted as a multipart/form-data file attachment. Name is not relevant. Uploads new firmware. The bin file should be posted as a multipart/form-data file attachment. Name is not relevant.

4
src/assets/version.h
View File

@ -4,10 +4,10 @@
const uint8_t VersionMajor = 2; const uint8_t VersionMajor = 2;
const uint8_t VersionMinor = 0; const uint8_t VersionMinor = 0;
const uint8_t VersionPatch = 0; const uint8_t VersionPatch = 0;
const uint8_t VersionMetadata = 7; const uint8_t VersionMetadata = 8;
const char VersionBranch[] = "release/2.0"; const char VersionBranch[] = "release/2.0";
const char VersionSemVer[] = "2.0.0-beta.1"; const char VersionSemVer[] = "2.0.0-beta.1";
const char VersionFullSemVer[] = "2.0.0-beta.1+7"; const char VersionFullSemVer[] = "2.0.0-beta.1+8";
const char VersionCommitDate[] = "2018-01-05"; const char VersionCommitDate[] = "2018-01-05";
#endif #endif