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
        }
    }
]

response: pong

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

type defines

dataArray

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