Ticker Service 1.0.0

Accepts one of the following messages:

• #0hello

  Payload

  object

  uid: hello

  type

  required

  string

  Const:"hello"

  Allowed values:
  • "hello"

  model

  required

  string

  uuid

  string

  version

  string

  firmwareChecksum

  string

  Additional properties are allowed.

  • #communication

  Examples

  Payload

  {
    "type": "hello",
    "model": "DPB0200",
    "uuid": "0a115964-659f-d095-b4f8-c2d468447ed9",
    "version": "1.0.0",
    "firmwareChecksum": "1df795aed8236272eb6f2ad3c5a489499c4a88597727a602fd0a03408564ce34"
  }
  

  This example has been generated automatically.

• #1parameter

  Payload

  oneOf

  Adheres to:

  object

  type

  string

  Const:"parameter"

  name

  string

  Const:"ticker_url"

  value

  string

  Default value:"wss://ticker.cryptoclock.net:443/"

  Additional properties are allowed.

  Or to:

  object

  type

  string

  Const:"parameter"

  name

  string

  Const:"brightness"

  value

  integer

  [ 0 .. 5 ]

  Default value:3

  Additional properties are allowed.

  Or to:

  object

  type

  string

  Const:"parameter"

  name

  string

  Const:"clock_interval"

  value

  integer

  Default value:30

  Additional properties are allowed.

  Or to:

  object

  type

  string

  Const:"parameter"

  name

  string

  Const:"clock_mode"

  value

  integer

  Default value:1

  Additional properties are allowed.

  Or to:

  object

  type

  string

  Const:"parameter"

  name

  string

  Const:"ntpserver"

  value

  string

  Default value:"0.xnet.pool.ntp.org"

  Additional properties are allowed.

  Or to:

  object

  type

  string

  Const:"parameter"

  name

  string

  Const:"rotate_display"

  value

  string

  Default value:0

  Allowed values:
  • "auto"
  • 0
  • 90
  • 180
  • 270

  Additional properties are allowed.

  Or to:

  object

  type

  string

  Const:"parameter"

  name

  string

  Const:"timezone"

  value

  integer

  [ 11 .. 13 ]

  Default value:2

  Additional properties are allowed.

  Or to:

  object

  type

  string

  Const:"parameter"

  name

  string

  Const:"update_url"

  value

  string

  Default value:"update.cryptoclock.net"

  Additional properties are allowed.

  • #configuration

  Examples

  Payload

  {
    "type": "parameter",
    "name": "ticker_url",
    "value": "wss://ticker.cryptoclock.net:443/"
  }
  

  This example has been generated automatically.

• #2parameters

  Payload

  object

  type

  string

  Const:"parameters"

  Allowed values:
  • "parameters"

  parameters

  array<anyOf>

  Array of currency pairs.

  Items:

  anyOf

  Can adhere to:

  object

  type

  string

  Const:"parameter"

  name

  string

  Const:"ticker_url"

  value

  string

  Default value:"wss://ticker.cryptoclock.net:443/"

  Additional properties are allowed.

  Or to:

  object

  type

  string

  Const:"parameter"

  name

  string

  Const:"brightness"

  value

  integer

  [ 0 .. 5 ]

  Default value:3

  Additional properties are allowed.

  Or to:

  object

  type

  string

  Const:"parameter"

  name

  string

  Const:"clock_interval"

  value

  integer

  Default value:30

  Additional properties are allowed.

  Or to:

  object

  type

  string

  Const:"parameter"

  name

  string

  Const:"clock_mode"

  value

  integer

  Default value:1

  Additional properties are allowed.

  Or to:

  object

  type

  string

  Const:"parameter"

  name

  string

  Const:"ntpserver"

  value

  string

  Default value:"0.xnet.pool.ntp.org"

  Additional properties are allowed.

  Or to:

  object

  type

  string

  Const:"parameter"

  name

  string

  Const:"rotate_display"

  value

  string

  Default value:0

  Allowed values:
  • "auto"
  • 0
  • 90
  • 180
  • 270

  Additional properties are allowed.

  Or to:

  object

  type

  string

  Const:"parameter"

  name

  string

  Const:"timezone"

  value

  integer

  [ 11 .. 13 ]

  Default value:2

  Additional properties are allowed.

  Or to:

  object

  type

  string

  Const:"parameter"

  name

  string

  Const:"update_url"

  value

  string

  Default value:"update.cryptoclock.net"

  Additional properties are allowed.

  Additional properties are allowed.

  • #configuration

  Examples

  Payload

  {
    "type": "parameters",
    "parameters": [
      {
        "type": "parameter",
        "name": "ticker_url",
        "value": "wss://ticker.cryptoclock.net:443/"
      }
    ]
  }
  

  This example has been generated automatically.

• #3OTPRequest

  User presses the OTP button on device

  Payload

  object

  uid: OTPRequest

  type

  string

  Const:"OTPRequest"

  Allowed values:
  • "OTPRequest"

  Additional properties are allowed.

  • #registration

  Examples

  Payload

  {
    "type": "OTPRequest"
  }
  

  This example has been generated automatically.

• #4heartbeat

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

  Payload

  object

  uid: heartbeat

  type

  string

  Const:"heartbeat"

  Allowed values:
  • "heartbeat"

  Additional properties are allowed.

  • #communication

  Examples

  Payload

  {
    "type": "heartbeat"
  }
  

  This example has been generated automatically.

• #5error

  Payload

  object

  uid: error

  type

  required

  string

  Const:"error"

  Allowed values:
  • "error"

  command

  required

  string

  text

  required

  string

  Additional properties are allowed.

  • #debug

  Examples

  Payload

  {
    "type": "error",
    "command": "setImage",
    "text": "Error, Image size must be 64x32..."
  }
  

  This example has been generated automatically.

• #6diagnostics

  Payload

  object

  uid: diagnostics

  type

  required

  string

  Const:"diagnostics"

  Allowed values:
  • "diagnostics"

  internalTemperature

  object

  current

  integer

  max

  integer

  Additional properties are allowed.

  lastResetReason

  object

  cpu0

  string

  cpu1

  string

  Additional properties are allowed.

  rotationChanged

  object

  degrees

  integer

  value

  integer

  Additional properties are allowed.

  uptime

  string

  wifi

  object

  channel

  integer

  bssid

  string

  rssi

  integer

  Additional properties are allowed.

  Additional properties are allowed.

  • #debug

  Examples

  Payload

  {
    "type": "diagnostics",
    "internalTemperature": {
      "current": 0,
      "max": 0
    },
    "lastResetReason": {
      "cpu0": "string",
      "cpu1": "string"
    },
    "rotationChanged": {
      "degrees": 0,
      "value": 0
    },
    "uptime": "string",
    "wifi": {
      "channel": 0,
      "bssid": "string",
      "rssi": 0
    }
  }
  

  This example has been generated automatically.

• #7fonts

  Payload

  object

  uid: fonts

  type

  required

  string

  Const:"fonts"

  Allowed values:
  • "fonts"

  names

  required

  array<string>

  Names of supported fonts.

  Items:

  string

  Default value:"default"

  Additional properties are allowed.

  • #configuration

  Examples

  Payload

  {
    "type": "fonts",
    "names": [
      "5x7"
    ]
  }
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0welcome

  Payload

  object

  uid: welcome

  type

  string

  Const:"welcome"

  Allowed values:
  • "welcome"

  text

  required

  string

  Welcome string

  Additional properties are allowed.

  • #communication

  Examples

  Payload

  {
    "type": "welcome",
    "text": "Welcome client 12311221-1312-1213-1231-123123132231"
  }
  

  This example has been generated automatically.

• #1allTimeHigh

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

  Payload

  object

  uid: allTimeHigh

  type

  required

  string

  Const:"allTimeHigh"

  Allowed values:
  • "allTimeHigh"

  data

  required

  array<object>

  Array of currency pairs.

  id

  required

  string

  value

  required

  string

  Additional properties are allowed.

  • #data

  Examples

  Payload

  {
    "type": "allTimeHigh",
    "data": [
      {
        "id": "1d14c6d4-b6aa-4f90-88ba-3501ca9bba61",
        "value": 99999.9
      }
    ]
  }
  

  This example has been generated automatically.

• #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.

  Payload

  object

  uid: tick

  type

  required

  string

  Const:"tick"

  Allowed values:
  • "tick"

  data

  required

  array<object>

  Array of new values for layouts.

  id

  required

  string

  value

  required

  string

  Additional properties are allowed.

  • #data

  Examples

  Payload

  {
    "type": "tick",
    "data": [
      {
        "id": "fbf59877-d56f-42b8-b0a7-4db230ed4090",
        "value": 6456.9
      }
    ]
  }
  

  This example has been generated automatically.

• #3OTP

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

  Payload

  object

  uid: OTP

  type

  string

  Const:"OTP"

  Allowed values:
  • "OTP"

  password

  integer

  Additional properties are allowed.

  • #registration

  Examples

  Payload

  {
    "type": "OTP",
    "password": 123456
  }
  

  This example has been generated automatically.

• #4OTP_ACK

  Server notifies about successful OTP usage

  Payload

  object

  type

  required

  string

  Const:"OTP_ACK"

  Allowed values:
  • "OTP_ACK"

  Additional properties are allowed.

  • #registration

  Examples

  Payload

  {
    "type": "OTP_ACK"
  }
  

  This example has been generated automatically.

• #5message

  Display rotating message on given screen

  Payload

  object

  uid: message

  type

  string

  Const:"message"

  Allowed values:
  • "message"

  text

  required

  string

  Text to display

  target

  required

  string

  Additional properties are allowed.

  • #data

  Examples

  Payload

  {
    "type": "message",
    "text": "Hello there!",
    "target": "29508f89-8b9c-480e-ac2c-2862efaae8b5"
  }
  

  This example has been generated automatically.

• #6staticMessage

  Display static message

  Payload

  object

  uid: staticMessage

  type

  string

  Const:"staticMessage"

  Allowed values:
  • "staticMessage"

  text

  required

  string

  Text to display

  durationSecs

  required

  integer

  How long should be the text displayed in seconds.

  target

  required

  string

  Additional properties are allowed.

  • #data

  Examples

  Payload

  {
    "type": "staticMessage",
    "text": "Hello there!",
    "durationSecs": 60,
    "target": "29508f89-8b9c-480e-ac2c-2862efaae8b5"
  }
  

  This example has been generated automatically.

• #7sound

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

  Payload

  object

  uid: sound

  type

  string

  Const:"sound"

  melodyRTTL

  string

  Additional properties are allowed.

  • #data

  Examples

  Payload

  {
    "type": "sound",
    "melodyRTTL": "StarwarsI:d=16,o=5,b=100:4e,4e,4e,8c,p,g,4e,8c,p,g,4e,4p,4b,4b,4b,8c6,p,g,4d#,8c,p,g,4e,8p"
  }
  

  This example has been generated automatically.

• #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

  Payload

  object

  uid: imageBegin

  type

  required

  string

  Const:"imageBegin"

  Allowed values:
  • "imageBegin"

  size

  required

  integer

  chunk_size

  integer

  Default value:1024

  Additional properties are allowed.

  • #data
  • #images

  Examples

  Payload

  {
    "type": "imageBegin",
    "size": 6282,
    "chunk_size": 1024
  }
  

  This example has been generated automatically.

• #9imageChunk

  Payload

  object

  uid: imageChunk

  type

  required

  string

  Const:"imageChunk"

  Allowed values:
  • "imageChunk"

  offset

  required

  integer

  chunk

  required

  string

  Additional properties are allowed.

  • #data
  • #images

  Examples

  Payload

  {
    "type": "imageChunk",
    "offset": 0,
    "chunk": "Qk2KGAAAAAAAA..."
  }
  

  This example has been generated automatically.

• #10imageEnd

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

  Payload

  object

  uid: imageEnd

  type

  required

  string

  Const:"imageEnd"

  Allowed values:
  • "imageEnd"

  action

  required

  string

  Allowed values:
  • "display"
  • "store"

  oneOf

  any

  Additional properties are allowed.

  • #data
  • #images

  Examples

  Payload

  {
    "type": "imageEnd",
    "action": "display",
    "oneOf": null
  }
  

  This example has been generated automatically.

• #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.

  Payload

  object

  uid: setTemplate

  type

  required

  string

  Const:"setTemplate"

  Allowed values:
  • "setTemplate"

  template

  required

  array<object>

  Array of new values for layouts.

  index

  required

  integer

  horizontal

  object

  uid: layout_format

  x

  integer

  y

  integer

  maxCharacters

  integer

  textAlignment

  string

  font

  required

  string

  color

  required

  string

  Additional properties are allowed.

  vertical

  object

  uid: layout_format

  x

  integer

  y

  integer

  maxCharacters

  integer

  textAlignment

  string

  font

  required

  string

  color

  required

  string

  Additional properties are allowed.

  Additional properties are allowed.

  • #configuration

  Examples

  Payload

  {
    "type": "setTemplate",
    "template": [
      {
        "index": 0,
        "horizontal": {
          "x": 2,
          "y": 2,
          "maxCharacters": 6,
          "textAlignment": "right",
          "font": "5x7",
          "color": "#00FF00"
        },
        "vertical": {
          "x": 2,
          "y": 2,
          "maxCharacters": 6,
          "textAlignment": "right",
          "font": "5x7",
          "color": "#00FF00"
        }
      }
    ]
  }
  

  This example has been generated automatically.

• #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.

  Payload

  object

  uid: layout

  type

  required

  string

  Const:"layout"

  Allowed values:
  • "layout"

  data

  required

  array<object>

  Array of new values for layouts.

  index

  required

  integer

  id

  required

  string

  displayName

  required

  string

  source

  required

  string

  format

  object

  text

  object

  color

  string

  Additional properties are allowed.

  horizontal

  object

  uid: layout_format

  x

  integer

  y

  integer

  maxCharacters

  integer

  textAlignment

  string

  font

  required

  string

  color

  required

  string

  Additional properties are allowed.

  vertical

  object

  uid: layout_format

  x

  integer

  y

  integer

  maxCharacters

  integer

  textAlignment

  string

  font

  required

  string

  color

  required

  string

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  • #configuration

  Examples

  Payload

  {
    "type": "layout",
    "data": [
      {
        "index": 0,
        "id": "fbf59877-d56f-42b8-b0a7-4db230ed4090",
        "displayName": "USD",
        "source": "/bitfinex/btc/usd",
        "format": {
          "text": {
            "color": "#FF0000"
          },
          "horizontal": {
            "x": 2,
            "y": 2,
            "maxCharacters": 6,
            "textAlignment": "right",
            "font": "5x7",
            "color": "#00FF00"
          },
          "vertical": {
            "x": 2,
            "y": 2,
            "maxCharacters": 6,
            "textAlignment": "right",
            "font": "5x7",
            "color": "#00FF00"
          }
        }
      }
    ]
  }
  

  This example has been generated automatically.

• #13requestParameters

  Server requests all stored parameter values

  Payload

  object

  type

  required

  string

  Const:"requestParameters"

  Allowed values:
  • "requestParameters"

  Additional properties are allowed.

  • #configuration

  Examples

  Payload

  {
    "type": "requestParameters"
  }
  

  This example has been generated automatically.

• #14setTimeout

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

  Payload

  object

  uid: setTimeout

  type

  string

  Const:"setTimeout"

  dataReceivedTimeoutSecs

  integer

  Additional properties are allowed.

  • #configuration

  Examples

  Payload

  {
    "type": "setTimeout",
    "dataReceivedTimeoutSecs": 180
  }
  

  This example has been generated automatically.

• #15heartbeat

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

  Payload

  object

  uid: heartbeat

  type

  string

  Const:"heartbeat"

  Allowed values:
  • "heartbeat"

  Additional properties are allowed.

  • #communication

  Examples

  Payload

  {
    "type": "heartbeat"
  }
  

  This example has been generated automatically.

• #16triggerUpdate

  Notifies client to check for firmware updates

  Payload

  object

  type

  required

  string

  Const:"triggerUpdate"

  Allowed values:
  • "triggerUpdate"

  Additional properties are allowed.

  • #configuration

  Examples

  Payload

  {
    "type": "triggerUpdate"
  }
  

  This example has been generated automatically.

• #17triggerReset

  Notifies client to restart the device

  Payload

  object

  type

  required

  string

  Const:"triggerReset"

  Allowed values:
  • "triggerReset"

  Additional properties are allowed.

  • #configuration

  Examples

  Payload

  {
    "type": "triggerReset"
  }
  

  This example has been generated automatically.