POST /protocols/m-bus/devices/start-discovery
FROM API REVISION 6.0
Used to start a M-Bus device discovery.
This request has to be sent to find the existing M-Bus devices.
If the discovery is already started, an error 409 Conflict is returned.
If a value is invalid inside the communicationSpeeds property, an error 422 Unprocessable Entity is returned.
An error 400 Bad Request will be returned if there is no module.
This resource return a Job ID, used to follow the progression of the discovery.
See [Jobs](http://eclypseapi.distech-controls.com/restApi/jobs "Jobs documentation") for more details.
Used when you are operating a browser without access to the header parameter. This allows you to choose which encoding you want to use for the response:
All these resources can be used according what the resource allows.
If this parameter is not in the request, the Application/Json will be chosen by default.
There are multiple possible values (according the resource):
The first two are the most often used.
There are multiple possible values according the resource:
If this parameter is not present during the request, and error 415 Unsupported Media Type will be thrown.
Object Name: Discovery
| Property Name | Type | Description | Method | |
|---|---|---|---|---|
| MeterLow | The discovery will be limited to meters with an |
address that falls within the specified low and high
limits.
If this property is not sent or is invalid, it will be set to 0.
Limits : 0-255 | POST |
MeterHigh | | The discovery will be limited to meters with an
address that falls within the specified low and high
limits.
If this property is not sent or is invalid, it will be set to 255.
Limits : 0-255 | POST |
CommunicationSpeeds | | The communication speeds of the meters to discover. It is recommended to choose only the communication speeds of the devices you want to discover, since adding speeds can slow down the discovery process.
This array needs to contain one value at least.
If this property is not present, all the values allowed will be applied
Allowed values :
300
600
1200
2400
4800
9600
19200
38400 | POST |
ClearCache | | Meters that were previously discovered are kept in the device’s cache and are not removed from the list unless the device is rebooted or a new discovery is performed with this option set to true. | POST |
DiscoveryMode | | It exists two mode :
Primary: Limits the discovery to the primary address of the devices on the network. This can speed up the discovery process. However, if two or more devices on the network have the same primary address, the discovery will fail for the devices that have the same address.
Secondary: Uses both the secondary address and manufacturer ID to discover devices on the network. Note that this mode can be time-consuming.
If this property is not sent, the mode Secondary will be used.
| POST |
Object Name: StartDiscovery
| Property Name | Type | Description | Method |
|---|---|---|---|
| JobId | String | This is the ID of the jobs where you can follow the process, or cancel the discovery. |
URL Example: https://0.0.0.0/api/rest/v1/protocols/m-bus/devices/start-discovery
{
"meterLow": 12,
"meterHigh": 16,
"communicationSpeeds": [
300,
600,
1200,
2400
],
"clearCache": true,
"discoveryMode": "primary"
}
URL Example: https://0.0.0.0/api/rest/v1/protocols/m-bus/devices/start-discovery
<?xml version="1.0" encoding="utf-8"?>
<Discovery>
<MeterLow>12</MeterLow>
<MeterHigh>16</MeterHigh>
<CommunicationSpeeds>
<CommunicationSpeed>300</CommunicationSpeed>
<CommunicationSpeed>600</CommunicationSpeed>
<CommunicationSpeed>1200</CommunicationSpeed>
<CommunicationSpeed>2400</CommunicationSpeed>
</CommunicationSpeeds>
<ClearCache>true</ClearCache>
<DiscoveryMode>Primary</DiscoveryMode>
</Discovery>
URL Example: https://0.0.0.0/api/rest/v1/protocols/m-bus/devices/start-discovery
{
"meterLow": 12,
"meterHigh": 16,
"communicationSpeeds": [
300,
600,
1200,
2400
],
"clearCache": true,
"discoveryMode": "primary"
}
URL Example: https://0.0.0.0/api/rest/v1/protocols/m-bus/devices/start-discovery
<?xml version="1.0" encoding="utf-8"?>
<Discovery>
<MeterLow>12</MeterLow>
<MeterHigh>16</MeterHigh>
<CommunicationSpeeds>
<CommunicationSpeed>300</CommunicationSpeed>
<CommunicationSpeed>600</CommunicationSpeed>
<CommunicationSpeed>1200</CommunicationSpeed>
<CommunicationSpeed>2400</CommunicationSpeed>
</CommunicationSpeeds>
<ClearCache>true</ClearCache>
<DiscoveryMode>Primary</DiscoveryMode>
</Discovery>