Skip to content

Latest commit

 

History

History
255 lines (199 loc) · 6.76 KB

WEBSOCKET.md

File metadata and controls

255 lines (199 loc) · 6.76 KB

PIXELIX

PIXELIX

License

Websocket API

Get display pixel colors

Command: GETDISP

Parameter:

  • N/A

Response:

  • Successful:
    • ACK;<slot-id>;<color>;<color>;...;<color>
    • <slot-id>: Id of current active slot.
    • <color>: Color as 32 bit hex value, starting with the row y = 0 and from x = 0 to N. Then the next row and etc.
  • Failed:
    • NACK

Get slots information

Command: SLOTS

Parameter:

  • N/A

Response:

  • Successful:
    • ACK;<max-slots>;<plugin-type>;<plugin-uid>;<slot-locked>;<slot-duration>...
    • <max-slots>: Max. number of slots.
    • <plugin-type>: The name of the installed plugin in "...".
    • <plugin-uid>: The plugin UID.
    • <plugin-alias>: The plugin alias name.
    • <slot-locked>: Whether slot is locked (1) or not (0).
    • <slot-duration>: Slot duration in ms.
    • The plugin type, plugin UID and whether slot is locked or not will be repeated for all slots. If a slot is empty, nothing will be in.
  • Failed:
    • NACK

Restart

Command: RESTART

Parameter:

  • N/A

Response:

  • Successful:
    • ACK
  • Failed:
    • NACK

Brightness

Get brightness information

Command: BRIGHTNESS

Parameter:

  • N/A

Set brightness

Command: BRIGHTNESS;<brightness>

Parameter:

  • <brightness>: Brightness in percent [0; 100].

Set brightness and enable/enable automatic brightness adjustment

Command: BRIGHTNESS;<brightness>;<automatic-brightness-control>

Parameter:

  • <brightness>: Brightness in percent [0; 100].
  • <automatic-brightness-control>: Enable (1) or disable (0) it.

Response

Response:

  • Successful:
    • ACK;<brightness>;<auto-brightness-adjustment>
  • Failed:
    • NACK

Get plugins information

Command: PLUGINS

Parameter:

  • N/A

Response:

  • Successful:
    • ACK;<plugin-info>; ...
    • <plugin-info>: The name of the plugin in "...". This will be repeated for all plugins.
  • Failed:
    • NACK

Install a plugin

Command: INSTALL;<plugin-name>

Parameter:

  • <plugin-name>: Name of the plugin to install.

Response:

  • Successful:
    • ACK;<slot-id>
    • <slot-id>: The id of the slot, where the plugin was installed.
    • <plugin-uid>: The plugin UID.
  • Failed:
    • NACK

Uninstall a plugin

Command: UNINSTALL;<slot-id>

Parameter:

  • <slot-id>: Id of the slot, where the plugin shall be uninstalled.

Response:

  • Successful:
    • ACK
  • Failed:
    • NACK

Move a plugin

Command: MOVE;<plugin-uid>;<slot-id>

Parameter:

  • <plugin-uid>: UID of the plugin, which to move.
  • <slot-id>: Id of the slot, where to move the plugin.

Response:

  • Successful:
    • ACK
  • Failed:
    • NACK

Enable/Disable logging

Is logging enabled?

Command: LOG

Response:

  • Successful:
    • ACK;<is-enabled>
    • <is-enabled>: 0 means disabled and 1 enabled
  • Failed:
    • NACK

Enable/Disable logging to websocket

Command: LOG;<enable>

Parameter:

  • <enable>: 0 to disable or 1 to enable

Response:

  • Successful:
    • ACK;<is-enabled>
    • <is-enabled>: 0 means disabled and 1 enabled
  • Failed:
    • NACK

Event: If logging is enabled, a event will be automatically be sent for every log message.

  • EVT;LOG;<timestamp>;<level>;<filename>;<line>;<text>
  • <timestamp>: Timestamp in ms
  • <level>: Log level
  • <filename>: Filename where the log message comes from, emphasized in "".
  • <line>: Line number if in the file where the log message comes from.
  • <text>: Logged text, emphasized in "".

Enable/Disable iperf

Is iperf enabled?

Command: IPERF

Response:

  • Successful:
    • ACK;<is-enabled>
    • <is-enabled>: 0 means disabled and 1 enabled
  • Failed:
    • NACK

Start/Stop iperf server

Command: IPERF;<CMD>;<OPTIONS>

Parameter:

  • <CMD>: START to start server; STOP to stop server
  • <OPTIONS>: Options are only valid for the START command.
    • 1st option is protocol: DEFAULT (= TCP), TCP, UDP
    • 2nd option is interval in s: DEFAULT (= 3) or value
    • 3rd option is time in s: DEFAULT (= 30) or value

Response:

  • Successful:
    • ACK;<is-enabled>
    • <is-enabled>: 0 means disabled and 1 enabled
  • Failed:
    • NACK

Trigger virtual user button

Command: BUTTON

Parameter:

  • N/A

Response:

  • Successful:
    • ACK
  • Failed:
    • NACK

Switch to next fade effect

Command: EFFECT

Parameter:

  • N/A

Response:

  • Successful:

    • ACK;<fadeEffect>
    • <fadeEffect>: ID of the fade effect

  • Failed:

    • NACK

Issues, Ideas And Bugs

If you have further ideas or you found some bugs, great! Create a issue or if you are able and willing to fix it by yourself, clone the repository and create a pull request.

License

The whole source code is published under the MIT license. Consider the different licenses of the used third party libraries too!

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any additional terms or conditions.