Document

obniz Hardware and cloud specifications.


switch

the switch embed on obniz itself. If it's state is changed, notification will be fired.

request: get

Related item

path type conditions description
switch string
  • required
  • const "get"
 
// Json Example
[
    {
        "switch": "get"
    }
]

response: change

path type conditions description
switch.state string
  • required
  • enum
    • "none"
    • "push"
    • "left"
    • "right"
 
switch.action string
  • const "get"
this is optional and added when user request 
//Response Example
[
    {
        "switch": {
            "state": "none",
            "action": "get"
        }
    }
]