ActivePortItem

Describes the an Active Communication Port to which downstream devices are connected.

The active Port on a Controller is used to communicate with downstreams and must be configured before use.

ActivePortItem Properties

ActivePortItem

Field Type Inherited from Description
AperioPortNumber Nullable<Int32> ActivePortItem Gets or sets the port number for Aperio Hubs
AperioUseTLS Nullable<Boolean> ActivePortItem Enables or Disables TLS for Aperio Hubs
BaudRate Int32 ActivePortItem Sets maximum BaudRate for the port. Used only for RS485 communication ports.
DriverNumber Int32 ActivePortItem Used to identify which port is being used. Retrieve the list of Communication ports from the controller, and then select the specific port by Driver Number.
Port Nullable<Int32> ActivePortItem Used to Identify port for Smart Controllers. Retrieve the list of SmartController ports from the controller, and then select the specific port by Port Number.
ReplyTime Int32 ActivePortItem Sets maximum Reply timeout for the port. 0 gives the default of 90 ms. The communications driver will force the default value if the time specified is less than 50 or greater than 150. This setting does not apply to the Internal or Virtual ports. Note: For TCP connected devices (port number = 4), the reply timeout value will be in units of 10 ms. For example to specify a maximum timeout of 1.5 seconds, specify a timeout value of 150.

JSON Structure of ActivePortItem

{
   "AperioPortNumber"	:	"Nullable\<Int32\>",
   "AperioUseTLS"	:	"Nullable\<Boolean\>",
   "BaudRate"	:	"Int32",
   "DriverNumber"	:	"Int32",
   "Port"	:	"Nullable\<Int32\>",
   "ReplyTime"	:	"Int32"
}

Get Active Ports Async

Example in C#

// Returns: IEnumerable<ActivePortItem>
var activePortItem = await client.GetActivePortsAsync(ControllerInfo controller);

Example in CURL



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

Set Active Port Async

Example in C#

// Returns: T
var item = await client.SetActivePortAsync<T>(T controller, ActivePortItem activePortItem);

Example in CURL



           curl -X PUT \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/controllers/CONTROLLERS.KEY/activeports \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '{
                       "$type":"Feenics.Keep.WebApi.Model.ActivePortItem, Feenics.Keep.WebApi.Model",
                       "DriverNumber":0,
                       "BaudRate":0
                   }'