PortSettings element
Defines the default port settings of the main device port. It also allows you to restrict the capabilities of the main device port, and to define the format and range of the bus address, if any.
Parent
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
| name | TypeNonEmptyString | Yes | Specifies the name of the additional protocol type as specified in the Protocol.Type@advanced attribute. |
| visibleInUi | EnumTrueFalse | If set to “false”, users cannot see or change the port settings for this additional protocol type when creating or editing an element.* |
* Not applicable for the main connection (Protocol.PortSettings), only for additional connections (Protocol.Ports.PortSettings).
Children
| Name | Occurrences | Description |
|---|---|---|
| All | ||
| Baudrate | [0, 1] | Allows to limit baud rate settings and to define a default value. |
| BusAddress | [0, 1] | Allows to limit bus address settings and to define a default value. |
| Databits | [0, 1] | Allows to limit bus databit settings and to define a default value. |
| Flowcontrol | [0, 1] | Allows to limit flow control settings and to define a default value. |
| FlushPerDatagram | [0, 1] | When set to true, any datagram received on the connection will be forwarded to SLProtocol immediately, which will then store it in the response parameter. |
| GetCommunity | [0, 1] | Specifies the GetCommunity string of an SNMP protocol. |
| IPport | [0, 1] | Specifies the IP port configuration. |
| LocalIPport | [0, 1] | Specifies the local IP port configuration. |
| Parity | [0, 1] | Allows to limit parity settings and to define a default value. |
| PingInterval | [0, 1] | Configures the ping interval. |
| PortTypeIP | [0, 1] | Specifies settings related to the TCP/IP port type. |
| PortTypeSerial | [0, 1] | Specifies settings related to the serial port type. |
| PortTypeUDP | [0, 1] | Specifies settings related to the UDP/IP port type. |
| Retries | [0, 1] | Configures the number of retries. |
| SetCommunity | [0, 1] | Specifies the SNMP set community string. |
| SlowPoll | [0, 1] | Specifies the slow poll configuration. |
| SlowPollBase | [0, 1] | Specifies the slow poll base settings. |
| SSH | [0, 1] | Specifies the SSH settings. |
| Stopbits | [0, 1] | Specifies the stop bits settings. |
| TimeoutTimeElement | [0, 1] | Specifies settings related to the element timeout. |
| TimeoutTime | [0, 1] | Specifies settings related to the timeout of a command/request. |
| Type | [0, 1] | Specifies the port type settings. |
Remarks
It is advised to always use this tag, because it greatly enhances the user-friendliness of the protocol. When users add new elements, the port values of those elements will by default be correct, and the process of configuring a new element will be far less error-prone.
The following table gives an overview of all tags that can be inserted into the /Protocol/PortSettings element.
For each of those tags, it also indicates the child elements that are allowed.
| Setting | Value | DefaultValue | Range.From | Range.To | Disabled |
|---|---|---|---|---|---|
| Baudrate | X | X | X | X | X |
| Busaddress | X | X | X | X | X |
| Databits | X | X | X | X | X |
| Flowcontrol | X | X | X | X | X |
| GetCommunity | X | X | |||
| IPport | X | X | |||
| LocalIPport | X | X | |||
| Parity | X | X | X | X | |
| PingInterval | X | X | |||
| PortTypeIP | X | ||||
| PortTypeSerial | X | ||||
| PortTypeUDP | X | ||||
| Retries | X | X | |||
| SetCommunity | X | X | |||
| SlowPoll | X | X | |||
| SlowPollBase | X | X | |||
| Stopbits | X | X | X | X | |
| TimeoutTime | X | X | |||
| TimeoutElement | X | X | |||
| Type | X |