Skip to content

default_api.md

Latest commit

 

History

History
198 lines (114 loc) · 5.12 KB

default_api.md

File metadata and controls

198 lines (114 loc) · 5.12 KB

default_api

All URIs are relative to http://localhost

Method HTTP request Description
get](default_api.md#get) POST /mbus/get/{device}/{baudrate}/{address}
getMulti](default_api.md#getMulti) POST /mbus/getMulti/{device}/{baudrate}/{address}/{maxframes}
hat](default_api.md#hat) GET /mbus/hat
hatOff](default_api.md#hatOff) POST /mbus/hat/off
hatOn](default_api.md#hatOn) POST /mbus/hat/on
mbus_api](default_api.md#mbus_api) GET /mbus/api
scan](default_api.md#scan) POST /mbus/scan/{device}/{baudrate}

get

String get(device, baudrate, address)

Gets data from the slave identified by {address}

Required Parameters

Name Type Description Notes
device String The serial device to scan - /dev/ is pre-pended to {device} by M-Bus HTTPD before scanning
baudrate **** Baudrate to communicate with M-Bus devices
address String The slave device to get data from

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, text/plain,

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMulti

String getMulti(device, baudrate, address, maxframes)

Gets data from the slave identified by {address}, and supports multiple responses from the slave

Required Parameters

Name Type Description Notes
device String The serial device to scan - /dev/ is pre-pended to {device} by M-Bus HTTPD before scanning
baudrate **** Baudrate to communicate with M-Bus devices
address String The slave device to get data from
maxframes i32 The slave device to get data from

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, text/plain,

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hat

models::Hat hat()

Gets Raspberry Pi Hat information

Required Parameters

This endpoint does not need any parameter.

Return type

models::Hat

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/plain,

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hatOff

hatOff()

Turns off power to the M-Bus

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain,

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hatOn

hatOn()

Turns on power to the M-Bus

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain,

[Back to top] [Back to API list] [Back to Model list] [Back to README]

mbus_api

String mbus_api()

Returns this API specification

Required Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, text/x-yaml,

[Back to top] [Back to API list] [Back to Model list] [Back to README]

scan

String scan(device, baudrate)

Scan the specified device for slaves

Required Parameters

Name Type Description Notes
device String The serial device to scan - /dev/ is pre-pended to {device} by M-Bus HTTPD before scanning
baudrate **** Baudrate to communicate with M-Bus devices

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]