itsblue-development/LedDisplay
itsblue-development/LedDisplay
2
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity

Update home

Dorian Zedler 2020-10-17 23:13:10 +00:00
parent 92bcdb3ede
commit 0b80a60890
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
home.md

@ -28,7 +28,7 @@ A reply will look like this:
`<data>` is additional data the command returned (see below). `<data>` is additional data the command returned (see below).
# Status codes # Status codes
```cpp ```c
enum OmobiDisplayStatusCode enum OmobiDisplayStatusCode
{ {
Success = 200, Success = 200,
@ -40,7 +40,7 @@ enum OmobiDisplayStatusCode
``` ```
# Text set parameters # Text set parameters
```cpp ```c
enum DisplayTextSetParameter enum DisplayTextSetParameter
{ {
TextParameter = 0, TextParameter = 0,
@ -57,7 +57,7 @@ enum DisplayTextSetParameter
``` ```
# Display controller error # Display controller error
```cpp ```c
enum GetSetTextSetParameterExitCode enum GetSetTextSetParameterExitCode
{ {
Success, Success,
@ -76,7 +76,7 @@ enum GetSetTextSetParameterExitCode
Command to initially authenticate with the display. Command to initially authenticate with the display.
This is requited in order to execute any other command (except keep alive). This is requited in order to execute any other command (except keep alive).
#### Request data #### Request data
``` ```json
{ {
"secret": "<display secret>" "secret": "<display secret>"
} }
@ -123,7 +123,7 @@ Command to get the current brightness of the display.
#### Request data #### Request data
`null` `null`
#### Reply data #### Reply data
``` ```json
{ {
"displayBrightness":<display brightness> "displayBrightness":<display brightness>
} }
@ -134,7 +134,7 @@ Command to get the current brightness of the display.
### `20` - Set text set parameter ### `20` - Set text set parameter
Command to set a single parameter of a single set. To create a new text set, just edit its index. Command to set a single parameter of a single set. To create a new text set, just edit its index.
#### Request data #### Request data
``` ```json
{ {
"index":<text set index>, "index":<text set index>,
"parameter":<text set parameter>, "parameter":<text set parameter>,
@ -147,7 +147,7 @@ Command to set a single parameter of a single set. To create a new text set, jus
### `21` - Set display brightness ### `21` - Set display brightness
Command to set the current brightness of the display Command to set the current brightness of the display
#### Request data #### Request data
``` ```json
{ {
"displayBrightness":<display brightness> "displayBrightness":<display brightness>
} }
@ -159,7 +159,7 @@ Command to set the current brightness of the display
### `22` - Set display code ### `22` - Set display code
Command to modify the code of the display that is used for authentication (see `0`). Command to modify the code of the display that is used for authentication (see `0`).
#### Request data #### Request data
``` ```json
{ {
"displayCode":"<display code>" "displayCode":"<display code>"
} }
@ -172,7 +172,7 @@ Command to modify the name of the display
#### Specialties #### Specialties
This command requires the display (and some clients) to be rebooted in order to take effect. This command requires the display (and some clients) to be rebooted in order to take effect.
#### Request data #### Request data
``` ```json
{ {
"displayName":"<display name" "displayName":"<display name"
} }