mbus-api 0.3.5

A RESTful HTTP API exposing (wired) M-Bus functionality
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198

# 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** | [****](.md)| Baudrate to communicate with M-Bus devices | 
  **address** | **String**| The slave device to get data from | 

### Return type

[**String**](string.md)

### Authorization

No authorization required

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **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** | [****](.md)| 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**](string.md)

### Authorization

No authorization required

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **hat**
> models::Hat hat()


Gets Raspberry Pi Hat information

### Required Parameters
This endpoint does not need any parameter.

### Return type

[**models::Hat**](hat.md)

### Authorization

No authorization required

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **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]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **mbus_api**
> String mbus_api()


Returns this API specification

### Required Parameters
This endpoint does not need any parameter.

### Return type

[**String**](string.md)

### Authorization

No authorization required

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **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** | [****](.md)| Baudrate to communicate with M-Bus devices | 

### Return type

[**String**](string.md)

### Authorization

No authorization required

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)