GET /protocols/bacnet/communication/network/ip-ports/{id}/
This resource allows you to view and set the IP network configuration parameters including BACnet Broadcast Management Device (BBMD) and Foreign Device for intranetwork connectivity.
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.
The port's instance.
Object Name: IpPort
| Property Name | Type | Description | Method |
|---|---|---|---|
| Enabled | Boolean | This enables/disables the routing of BACnet packets between BACnet MS/TP controllers connected to the ECLYPSE Connected System Controller’s RS-485 port and BACnet/IP controllers connected to the ECLYPSE Connected System Controller’s Ethernet Switch ports. | GET POST |
| NetworkNumber | Integer | A network number identifies a LAN for routing purposes. All controllers with the same network number are members of the same logical BACnet network. Min : 1 Max : 65534 |
GET POST |
| BacnetIpUdpPort | Integer | This is the standard BACnet/IP port number (UDP 47808) used by BACnet devices to communicate. Min : 0 Max : 65535 |
GET POST |
| EnabledBbmd | Boolean | BBMD allows broadcast message to pass through a router. To enable this feature, set Enable BBMD on only one device on each subnet. |
GET POST |
| EnabledForeignDevice | Boolean | Foreign Device Registration allows a BACnet/IP device to send broadcast messages to a device with BBMD enabled. To enable this feature, set Enable Foreign Devices on only one device on each subnet. |
GET POST |
| BbmdList | Array <Bbmd> |
This object is an array of all the Bbmd created on the device. | GET |
| ForeignDevices | Array <ForeignDevice> |
This object is an array of ForeignDevice object. It lists all the foreign device present on the device. | GET |
| Id | Integer | This is the Id of the IP port. | GET |
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/communication/network/ip-ports/1
{
"id": 1,
"bacnetIpUdpPort": 47810,
"enabledBbmd": true,
"enabled": true,
"enabledForeignDevice": true,
"foreignDevices": {
"href": "/api/rest/v1/protocols/bacnet/communication/network/ip-ports/111/foreign-devices",
"name": "foreignDevices"
},
"networkNumber": 2102,
"bbmds": {
"href": "/api/rest/v1/protocols/bacnet/communication/network/ip-ports/111/bbmd-list",
"name": "bbmds"
}
}
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/communication/network/ip-ports/1
<?xml version="1.0" encoding="utf-8"?>
<IpPort>
<Id>1</Id>
<Enabled>true</Enabled>
<NetworkNumber>2102</NetworkNumber>
<BacnetIpUdpPort>47810</BacnetIpUdpPort>
<EnabledBbmd>false</EnabledBbmd>
<EnabledForeignDevice>false</EnabledForeignDevice>
<BbmdList>
<Href>
/api/rest/v1/protocols/bacnet/communication/network/ip-ports/2102/bbmd-list
</Href>
<Name>bbmds</Name>
</BbmdList>
<ForeignDevices>
<Href>
/api/rest/v1/protocols/bacnet/communication/network/ip-ports/2102/foreign-devices
</Href>
<Name>foreignDevices</Name>
</ForeignDevices>
</IpPort>
Eclypse REST API Document Revision 10.2