Segment Configuration
glp/0/{SID}/(rq|fb)/cfg |
This topic accepts and reports the segment's configuration, used to control properties that govern the overall behavior of the segment. This topic is refreshed whenever the edge server starts, because its content can be affected by configuration files or other parameters to the edge server. Any other change to the segment configuration object also refreshes the object in the feedback channel.
Clients can publish a complete or partial configuration object in the request channel or publish an update action with a complete or partial configuration object. Other inputs, such as input derived from edge protocol or system events, may also change the configuration object and trigger the publication of the new object in the feedback channel.
Properties
The segment configuration object has the following properties:
Field Name | Type | Notes | |||||||||||||||||||||||||||||||||||
black | List of strings | List of blacklisted devices using the device’s protocol identifier and its protocol-specific unique identifier. | |||||||||||||||||||||||||||||||||||
For example: [ "lon:050320CAB2105" ] | |||||||||||||||||||||||||||||||||||||
time | Object | time is used to configure the current UTC time and date and the local timezone and daylight savings rule. Date and time values embedded within the time object are broken into numeric components. These values reported in the feedback channel are as they were last assigned, and do not necessarily reflect the edge server's current date and time. These are always in UTC, the edge server computes local time based on UTC time and the timezone rules included with the time object. The time object has these fields:
| |||||||||||||||||||||||||||||||||||
discovery | Number | The discovery property enables and configures automatic device discovery procedures, executing periodically and automatically. For more explicit control over device discovery see Manual Device Discovery. discovery uses a value in the 0..1 range to indicate the relative discovery speed, where 0 means “no discovery” and 1 means “as fast as possible.” This property is ignored if discovery is not supported, as indicated in the About topic. The edge processor is responsible for selecting an appropriate discovery frequency, suitable for the edge protocol and its condition within this segment, if device discovery is an active process undertaken by the edge processor. The edge processor may ignore this guidance, for example for systems where device discovery is a passive process from an edge processor’s point of view. | |||||||||||||||||||||||||||||||||||
events | List of event category names. | List of event categories for live event reporting (see Events). The possible values are:
| |||||||||||||||||||||||||||||||||||
key | List of strings | (Optional) List of key values. Up to one key for each protocol may be provided a key in a protocol-specific format. IAP has no generic meaning for this attribute, but the usage shall be unambiguous within a given protocol. For example, a LonTalk processor might use this for the authentication key shared among all devices governed by the edge server, while a Control-M processor might use this for the radio communication encryption key. | |||||||||||||||||||||||||||||||||||
Example: | |||||||||||||||||||||||||||||||||||||
language | string | The currently selected language for localized diagnostics. The default is “en” (English). The language parameter selects one of the available languages for localized diagnostics. Available languages are reported in the edge server’s About topic. | |||||||||||||||||||||||||||||||||||
loc | object | The location object identifies the location of the edge server. It consists of the properties described in Location Object. | |||||||||||||||||||||||||||||||||||
log_days | Number | Number of days to keep an event log. See Events. | |||||||||||||||||||||||||||||||||||
smtp | Internet server object | (Optional) The Internet Server object defines an email server. The following table lists the properties for smtp and ntp.
| |||||||||||||||||||||||||||||||||||
| mode | String | (Optional) Possible values are: onnet, offnet, or maintenance. The default is: onnet Protocol drivers watch the feedback channel’s segment configuration object and implement the following behavior based on the value reported with this property:
| |||||||||||||||||||||||||||||||||||
ntp | Internet server object | (Optional) The Internet Server object defines a Network Time Protocol (ntp) server. This field contains the address property, which is a string. | |||||||||||||||||||||||||||||||||||
tracing | Boolean | (Optional) Enable or disable tracing. When enabled, tracing records every change to the IAP feedback and request channels within an edge server. Because of the potentially significant data volume and performance impact of processing this data, tracing is disabled by default. Default is False. | |||||||||||||||||||||||||||||||||||
uplinkFreq | number | (Optional) Three timers (uplink_freq, uplink_idle, and uplink_drop) govern the use of a dial-up modem through which the edge server establishes an uplink connection to the CMS’ message broker. These timers are ignored by units with permanent networking connections. uplink_freq defines the frequency, in seconds, with which the uplink is enabled. This enables the radio. The edge server must handle failure in a way suitable for the radio technology. For example, it could try every 90 seconds to enable the radio, obtain signal, obtain an IP address, etc. Once the uplink is available, the timer is started for the next interval. The uplink_freq defines the duration between “radio on” events, not the radio downtime duration. | |||||||||||||||||||||||||||||||||||
| Example: 14400 | |||||||||||||||||||||||||||||||||||||
uplinkIdle | number | Three timers (uplink_freq, uplink_idle, and uplink_drop) govern the use of a dial-up modem through which the edge server establishes an uplink connection to the CMS’ message broker. These timers are ignored by units with permanent networking connections. uplink_idle defines the maximum duration of the idle period in an open uplink connection, in seconds. When no networking traffic is encountered for this idle period, the radio is shut down. The edge server specification defines what constitutes an idle link, since the ability to determine idleness may be hardware dependent. Some controllers may be able to detect “true idleness” while others may only be able to detect idleness in terms of IAP messages. A value of 0 (zero) disables the idle timeout. | |||||||||||||||||||||||||||||||||||
| Example: 60 | |||||||||||||||||||||||||||||||||||||
uplinkDrop | number | Three timers (uplink_freq, uplink_idle, and uplink_drop) govern the use of a dial-up modem through which the edge server establishes an uplink connection to the CMS’ message broker. These timers are ignored by units with permanent networking connections. uplink_drop defines the maximum duration of an uplink connection, regardless of its idleness. A value of 0 (zero) disables the enforced expiry timeout. | |||||||||||||||||||||||||||||||||||
| Example: 300 | |||||||||||||||||||||||||||||||||||||
| name | String | (Optional) String containing a name for the segment. Can be missing or null. | |||||||||||||||||||||||||||||||||||
| Example: "Assembly Line 3" | |||||||||||||||||||||||||||||||||||||
| desc | String | (Optional) String containing a description for the segment. Can be missing or null. | |||||||||||||||||||||||||||||||||||
| timeSource | String | String containing the time source. Valid values are as follows:
Default is ntp. | |||||||||||||||||||||||||||||||||||
Examples: ntp {
"timeSource": "ntp",
"ntp": {
"address": "<IP/URL>"/null
},
"time": {
"zone": "America/Montevideo"
}
}
bacnet {
"timeSource": "bacnet",
"time": {
"zone": "America/Montevideo"
}
}
manual {
"timeSource": "manual",
"time": {
"year": "2022",
"month": "02",
"day": "02",
"hour": "02",
"minute": "02",
"second": "02",
"zone": "America/Montevideo"
}
}
| |||||||||||||||||||||||||||||||||||||