obniz Docs Reference Websocket API System

System

system

request: wait

path type conditions description
system.wait integer
  • required
 wait time (ms)  
// Json Example
[
    {
        "system": {
            "wait": 500
        }
    }
]

request: reset

path type conditions description
system.reset boolean
  • required
  • const true
   
// Json Example
[
    {
        "system": {
            "reset": true
        }
    }
]

request: reboot

path type conditions description
system.reboot boolean
  • required
  • const true
   
// Json Example
[
    {
        "system": {
            "reboot": true
        }
    }
]

request: selfCheck

circuit IO check

path type conditions description
system.self_check boolean
  • required
  • const true
   
// Json Example
[
    {
        "system": {
            "self_check": true
        }
    }
]

request: keepWorkingAtOffline

reset obniz Board when obniz Board gone to offline.

path type conditions description
system.keep_working_at_offline boolean
  • required
   
// Json Example
[
    {
        "system": {
            "keep_working_at_offline": true
        }
    }
]

request: ping

path type conditions description
system.ping.key dataArray
  • required
   
// Json Example
[
    {
        "system": {
            "ping": {
                "key": [16, 34, 242]
            }
        }
    }
]

request: sleepSeconds

path type conditions description
system.sleep_seconds integer
  • required
 sleep time (seconds)  
// Json Example
[
    {
        "system": {
            "sleep_seconds": 500
        }
    }
]

request: sleepMinute

path type conditions description
system.sleep_minute integer
  • required
 sleep time (minute)  
// Json Example
[
    {
        "system": {
            "sleep_minute": 500
        }
    }
]

request: sleepIoTrigger

path type conditions description
system.sleep_io_trigger boolean
  • required
 true:Wake up on rising edge false:Wake up on falling edge  
// Json Example
[
    {
        "system": {
            "sleep_io_trigger": true
        }
    }
]

request: set_clock

path type conditions description
system.clock integer
  • required
 Set the clock (Unix timestamp in milliseconds). This will be set to device immediately and used as device timestamp  
// Json Example
[
    {
        "system": {
            "clock": 1592171234567
        }
    }
]

request: queue_mode

path type conditions description
system.queue_mode.interval integer   Set interval of transmission queue of device. Unit is milliseconds. Default is 0ms 
system.queue_mode.timestamp string
  • enum
    • "none"
    • "unix_seconds"
    • "unix_milliseconds"
 Set timestamp mode. In timestamp mode, device add timestamp to every commands. Default is none. sec use 4 bytes and millisec use 8 bytes  
// Json Example
[
    {
        "system": {
            "queue_mode": {
                "interval": 1000,
                "timestamp": "none"
            }
        }
    }
]

response: pong

path type conditions description
system.pong.key dataArray
  • required
   
//Response Example
[
    {
        "system": {
            "pong": {
                "key": [16, 34, 242]
            }
        }
    }
]

response: timestamp

path type conditions description
system.timestamp number
  • required
 The timestamp in milliseconds since epoch (1970-01-01T00:00:00Z).  
//Response Example
[
    {
        "system": {
            "timestamp": 1592171234567
        }
    }
]

type defines

dataArray

type conditions examples description
array
  • items
    • 0 ≤ value ≤ 255
  • [16, 34, 242]
  • [100, 255, 21, 0, 21]
 Binary data array.