This website is available for multi language.

ws

request: reset_obniz_on_ws_disconnection

path type conditions description
ws.reset_obniz_on_ws_disconnection boolean
  • required
   
// Json Example
[
    {
        "ws": {
            "reset_obniz_on_ws_disconnection": false
        }
    }
]

response: ready

all things ready

path type conditions description
ws.ready boolean
  • required
  • const true
   
//Response Example
[
    {
        "ws": {
            "ready": true
        }
    }
]

response: obniz

target device information

path type conditions description
ws.obniz.hw string
  • required
 Hardware Identifier String of target device 
ws.obniz.firmware string
  • required
 Installed firmware version of target device  
//Response Example
[
    {
        "ws": {
            "obniz": {
                "hw": "obnizb1",
                "firmware": "2.0.0"
            }
        }
    }
]

response: redirect

If the server required you to connect other endpoint to communicate with your obniz. This json will be sent.

path type conditions description
ws.redirect string
  • required
 The url you should redirect to.  
//Response Example
[
    {
        "ws": {
            "redirect": "wss://ws1.obniz.io"
        }
    }
]
Copyright © CambrianRobotics inc.