obniz Docs Reference Websocket API IO

IO

io

General purpose IO available on each io (io0 to io11).

request: input

Related item

path type conditions description
ioX string
  • required
  • const "get"
   

// Json Example
[
    {
        "io0": "get"
    }
]

request: input_detail

Related item

path type conditions description
ioX.direction string
  • required
  • const "input"
  
ioX.stream boolean   enable stream callback when value change  

// Json Example
[
    {
        "io0": {
            "direction": "input",
            "stream": false
        }
    }
]

request: output

path type conditions description
ioX boolean
  • required
   

// Json Example
[
    {
        "io0": true
    }
]

request: output_detail

path type conditions description
ioX.direction string
  • required
  • const "output"
  
ioX.value boolean
  • required
   

// Json Example
[
    {
        "io0": {
            "direction": "output",
            "value": true
        }
    }
]

request: output_type

path type conditions description
ioX.output_type string
  • required
  • enum
    • "push-pull5v"
    • "push-pull3v"
    • "open-drain"
 drive type  

// Json Example
[
    {
        "io0": {
            "output_type": "push-pull5v"
        }
    }
]

request: pull_type

path type conditions description
ioX.pull_type string
  • required
  • enum
    • "pull-up5v"
    • "pull-up3v"
    • "pull-down"
    • "float"
   

// Json Example
[
    {
        "io0": {
            "pull_type": "pull-up5v"
        }
    }
]

request: deinit

path type conditions description
ioX null
  • required
   

// Json Example
[
    {
        "io0": null
    }
]

response: get

path type conditions description
ioX boolean
  • required
   

//Response Example
[
    {
        "io0": true
    }
]

response: warning

path type conditions description
ioX.warning.message string
  • required
 io warning  

//Response Example
[
    {
        "io0": {
            "warning": {
                "message": "Heavy output"
            }
        }
    }
]

response: error

path type conditions description
ioX.error.message string
  • required
 io warning  

//Response Example
[
    {
        "io0": {
            "error": {
                "message": "Heavy output"
            }
        }
    }
]