obniz Docs Reference Websocket API Plugin

Plugin

plugin

plugin command

request: send

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

response: receive

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

response: frame

path type conditions description
plugin.frame.start.id number   Frame Identifer number 
plugin.frame.start.length number
  • required
 Frame Total length 
plugin.frame.end.length number     
//Response Example
[
    {
        "plugin": {
            "frame": {
                "start": {
                    "id": 100,
                    "length": 10000
                },
                "end": {
                    "length": 500
                }
            }
        }
    }
]

type defines

dataArray

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