obniz Docs Reference Websocket API Measurement

Measurement

measure

request: echo

It measures pulse response.

Related item

path type conditions description
measure.echo.io_pulse pinSetting
  • required
  
measure.echo.io_echo pinSetting
  • required
  
measure.echo.pulse string
  • default positive
  • enum
    • "positive"
    • "negative"
  
measure.echo.pulse_width number
  • required
  • 0.001 ≤ value ≤ 1000
  
measure.echo.measure_edges integer
  • 1 ≤ value ≤ 4
  
measure.echo.timeout number
  • default 1000
  • 0.001 ≤ value ≤ 1000
   
// Json Example
[
    {
        "measure": {
            "echo": {
                "io_pulse": 0,
                "io_echo": 1,
                "pulse": "positive",
                "pulse_width": 500,
                "measure_edges": 2,
                "timeout": 1000
            }
        }
    }
]

response: echo

path type conditions description
measure.echo[].edge boolean
  • required
 rising = true 
measure.echo[].timing number
  • required
 milliseconds from end of pulse  
//Response Example
[
    {
        "measure": {
            "echo": [
                {
                    "edge": true,
                    "timing": 500
                }
            ]
        }
    }
]

type defines

pinSetting

type conditions examples description
integer
  • 0 ≤ value ≤ 40
  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6