Ticker Service 1.0.0

This service serves data and configuration to ticker devices

Servers

  • wss://ticker.cryptoclock.net/?uuid={uuid}wssproduction

    Production websocket

    uuid
    required
    string

    This value is assigned by the device itself.

      Examples values:
    • "64da95ef-fcef-41e4-930f-e5e253339692"
  • wss://ticker.staging.cryptoclock.net/?uuid={uuid}wssstaging

    Staging websocket - prerelease testing

    uuid
    required
    string

    This value is assigned by the device itself.

      Examples values:
    • "64da95ef-fcef-41e4-930f-e5e253339692"

Operations

  • PUB /

    Send messages to the API

    Operation IDprocessReceivedMessage

    Accepts one of the following messages:

    • #0hello
      object
      uid: hello
      • #communication

      Examples

    • #1parameter
      oneOf
      • #configuration

      Examples

    • #2parameters
      object
      • #configuration

      Examples

    • #3OTPRequest

      User presses the OTP button on device

      object
      uid: OTPRequest
      • #registration

      Examples

    • #4heartbeat

      server sending heartbeat to keep the connection alive and client sending heartbeat to keep server informed it's still connected

      object
      uid: heartbeat
      • #communication

      Examples

    • #5error
      object
      uid: error
      • #debug

      Examples

    • #6diagnostics
      object
      uid: diagnostics
      • #debug

      Examples

    • #7fonts
      object
      uid: fonts
      • #configuration

      Examples

  • SUB /

    Messages that you receive from the API

    Operation IDsendMessage

    Accepts one of the following messages:

    • #0welcome
      object
      uid: welcome
      • #communication

      Examples

    • #1allTimeHigh

      Highest ever value for given item can be provided by server in similar fashion as tick.

      object
      uid: allTimeHigh
      • #data

      Examples

    • #2tick

      Value updates are received as "tick" commands. For devices capable of displaying more than one value, "id" field refers to particular display slot, associated beforehand by "layout" command.

      object
      uid: tick
      • #data

      Examples

    • #3OTP

      Server sends otp to the device. Password has to be presented to user.

      object
      uid: OTP
      • #registration

      Examples

    • #4OTP_ACK

      Server notifies about successful OTP usage

      object
      • #registration

      Examples

    • #5message

      Display rotating message on given screen

      object
      uid: message
      • #data

      Examples

    • #6staticMessage

      Display static message

      object
      uid: staticMessage
      • #data

      Examples

    • #7sound

      Plays a melody specified in RTTL format (only for devices with attached buzzer)

      object
      uid: sound
      • #data

      Examples

    • #8imageBegin

      Display an image, format must be 24-bit .bmp image, with same size as display image is split into X-bytes chunks (default 1024), each individually base64-encoded

      object
      uid: imageBegin
      • #data
      • #images

      Examples

    • #9imageChunk
      object
      uid: imageChunk
      • #data
      • #images

      Examples

    • #10imageEnd

      Display an image or store it on device's filesystem for use as logo

      object
      uid: imageEnd
      • #data
      • #images

      Examples

    • #11setTemplate

      For devices capable of displaying multiple values, templates are collections of display formating options for each "display slot". Each format contains display position(x,y) and attributes such as color, font or text alignment. Formats can be divided into horizontal/vertical pairs; appropriate format is then selected based on physical device orientation. Devices contain default templates in case of displaying 1-n values, that are automatically selected based on number of displayed values. Using setTemplate command overrides current template until device restart. Formatting options for any "display slot" can be overriden using layout command.

      object
      uid: setTemplate
      • #configuration

      Examples

    • #12layout

      If device is capable of displaying multiple values, "display slots" on a device are identified by index (0,1,2 etc). The layout command is used to associate display slot index with unique service ID, which is sent by "tick" command on each value update. Optional "format" parameter specifies overrides for default display settings such as font, color, x/y position etc. See "setTemplate" command for additional details.

      object
      uid: layout
      • #configuration

      Examples

    • #13requestParameters

      Server requests all stored parameter values

      object
      • #configuration

      Examples

    • #14setTimeout

      Server can set some of device's timeouts (in case of server source sending values too infrequently)

      object
      uid: setTimeout
      • #configuration

      Examples

    • #15heartbeat

      server sending heartbeat to keep the connection alive and client sending heartbeat to keep server informed it's still connected

      object
      uid: heartbeat
      • #communication

      Examples

    • #16triggerUpdate

      Notifies client to check for firmware updates

      object
      • #configuration

      Examples

    • #17triggerReset

      Notifies client to restart the device

      object
      • #configuration

      Examples

Messages

  • #1allTimeHigh

    Highest ever value for given item can be provided by server in similar fashion as tick.

    object
    uid: allTimeHigh
    • #data
  • #2diagnostics
    object
    uid: diagnostics
    • #debug
  • #3error
    object
    uid: error
    • #debug
  • #4fonts
    object
    uid: fonts
    • #configuration
  • #5heartbeat

    server sending heartbeat to keep the connection alive and client sending heartbeat to keep server informed it's still connected

    object
    uid: heartbeat
    • #communication
  • #6hello
    object
    uid: hello
    • #communication
  • #7imageBegin

    Display an image, format must be 24-bit .bmp image, with same size as display image is split into X-bytes chunks (default 1024), each individually base64-encoded

    object
    uid: imageBegin
    • #data
    • #images
  • #8imageChunk
    object
    uid: imageChunk
    • #data
    • #images
  • #9imageEnd

    Display an image or store it on device's filesystem for use as logo

    object
    uid: imageEnd
    • #data
    • #images
  • #10layout

    If device is capable of displaying multiple values, "display slots" on a device are identified by index (0,1,2 etc). The layout command is used to associate display slot index with unique service ID, which is sent by "tick" command on each value update. Optional "format" parameter specifies overrides for default display settings such as font, color, x/y position etc. See "setTemplate" command for additional details.

    object
    uid: layout
    • #configuration
  • #11message

    Display rotating message on given screen

    object
    uid: message
    • #data
  • #12OTP

    Server sends otp to the device. Password has to be presented to user.

    object
    uid: OTP
    • #registration
  • #13OTP_ACK

    Server notifies about successful OTP usage

    object
    • #registration
  • #14OTPRequest

    User presses the OTP button on device

    object
    uid: OTPRequest
    • #registration
  • #15parameter
    oneOf
    • #configuration
  • #16parameters
    object
    • #configuration
  • #17requestParameters

    Server requests all stored parameter values

    object
    • #configuration
  • #18setTemplate

    For devices capable of displaying multiple values, templates are collections of display formating options for each "display slot". Each format contains display position(x,y) and attributes such as color, font or text alignment. Formats can be divided into horizontal/vertical pairs; appropriate format is then selected based on physical device orientation. Devices contain default templates in case of displaying 1-n values, that are automatically selected based on number of displayed values. Using setTemplate command overrides current template until device restart. Formatting options for any "display slot" can be overriden using layout command.

    object
    uid: setTemplate
    • #configuration
  • #19setTimeout

    Server can set some of device's timeouts (in case of server source sending values too infrequently)

    object
    uid: setTimeout
    • #configuration
  • #20sound

    Plays a melody specified in RTTL format (only for devices with attached buzzer)

    object
    uid: sound
    • #data
  • #21staticMessage

    Display static message

    object
    uid: staticMessage
    • #data
  • #22tick

    Value updates are received as "tick" commands. For devices capable of displaying more than one value, "id" field refers to particular display slot, associated beforehand by "layout" command.

    object
    uid: tick
    • #data
  • #23triggerReset

    Notifies client to restart the device

    object
    • #configuration
  • #24triggerUpdate

    Notifies client to check for firmware updates

    object
    • #configuration
  • #25welcome
    object
    uid: welcome
    • #communication

Schemas

  • object
    uid: allTimeHigh
  • object
    uid: diagnostics
  • object
    uid: error
  • object
    uid: fonts
  • object
    uid: heartbeat
  • object
    uid: hello
  • object
    uid: imageBegin
  • object
    uid: imageChunk
  • object
    uid: imageEnd
  • object
    uid: layout
  • object
    uid: layout_format
  • object
    uid: message
  • object
    uid: OTP
  • object
    uid: OTPRequest
  • parameters
    any
    uid: parameters
  • object
    uid: setTemplate
  • object
    uid: setTimeout
  • object
    uid: sound
  • object
    uid: staticMessage
  • object
    uid: tick
  • object
    uid: welcome