CommunicationPortDefinitionItem

Describes a communication port of a specific controllerThe CommuncationPortDefintionItem is a one static set of values for a specific port. Get the list of all available ports from the Controller. Use the DriverNumber to idenify which port is Active ActivePortItem

This is the description of what kind of port is being looked at. In computer networking, a port is an endpoint of communication. Physical as well as wireless connections are terminated at ports of hardware devices. At the software level, within an operating system, a port is a logical construct that identifies a specific process or a type of network service.

CommunicationPortDefinitionItem Properties

CommunicationPortDefinitionItem

Field Type Inherited from Description
BoardPort String CommunicationPortDefinitionItem The downstream SIO communication Port
CommonName String CommunicationPortDefinitionItem Common Name of the port, suitable for display
DriverNumber Int32 CommunicationPortDefinitionItem Driver Number, used to reference this port in the list of Active Ports ActivePortItem
IsInternal Boolean CommunicationPortDefinitionItem Identifies this port as an Internal (OnBoard) Port
IsNetwork Boolean CommunicationPortDefinitionItem Identifies this port as a Network (Virtual) Port
NumberOfDownstreamDevices Int32 CommunicationPortDefinitionItem The maximum number of downstream devices allowed on this port.
PhysicalNumber Int32 CommunicationPortDefinitionItem Physical Number

JSON Structure of CommunicationPortDefinitionItem

{
   "BoardPort"	:	"String",
   "CommonName"	:	"String",
   "DriverNumber"	:	"Int32",
   "IsInternal"	:	"Boolean",
   "IsNetwork"	:	"Boolean",
   "NumberOfDownstreamDevices"	:	"Int32",
   "PhysicalNumber"	:	"Int32"
}

Get Communication Port Definitions Async

Example in C#

// Returns: IEnumerable<CommunicationPortDefinitionItem>
var communicationPortDefinitionItem = await client.GetCommunicationPortDefinitionsAsync(ControllerInfo controllerInfo);

Example in CURL



           curl -X GET \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/controllers/CONTROLLER.KEY/comports  \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'

Example in CURL



           curl -X GET \
               https://api.us.acresecurity.cloud/api/comports/CONTROLLER_TYPE_INFO_NAME  \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'

Get Communication Port Definitions Async

Example in C#

// Returns: IEnumerable<CommunicationPortDefinitionItem>
var communicationPortDefinitionItem = await client.GetCommunicationPortDefinitionsAsync(String controllerTypeInfoName);

Example in CURL



           curl -X GET \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/controllers/CONTROLLER.KEY/comports  \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'

Example in CURL



           curl -X GET \
               https://api.us.acresecurity.cloud/api/comports/CONTROLLER_TYPE_INFO_NAME  \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'