SensorConfiguration

data class SensorConfiguration(val serialNumber: String? = null, val payloadSplitInfo: Int? = null, val configurationHash: Int? = null, val configurationHashTimestamp: Long? = null, val configurationErrors: ConfigurationErrors? = null, val measurementTypes: Map<Channel, Measurement.Type>? = null, val nvmStatus: NVMStatus? = null, val currentTime: Long? = null, val acceptWithoutTestingRequest: Boolean? = null, val configurationRequest: Boolean? = null, val deviceInfoRequest: Boolean? = null, val extendedConfigurationRequest: Boolean? = null, val updateSoftwareRequest: Boolean? = null, val clearRuntimeErrorsRequest: Boolean? = null, val disableModemAfterTimeRequest: Int? = null, val updateModemRequest: String? = null, val resetMemoryRequest: Boolean? = null, val restartMemoryStatsRequest: Boolean? = null, val dataTransferStartTimestampRequest: Long? = null, val setOutputControlStateRequest: Map<Channel, Boolean>? = null, val measurementPeriod: MeasurementPeriod? = null, val bluetoothTurnoff: BluetoothTurnOff? = null, val bluetoothTxPowerLevel: TxPowerLevel? = null, val encryptionKey: String? = null, val bluetoothAdvertisingMode: BluetoothAdvertisingMode? = null, val advertisementManufacturerDataFormat: AdvertisementManufacturerDataFormat? = null, val rules: List<Rule>? = null, val ruleCalendars: List<RuleCalendar>? = null, val transmissionInterval: TransmissionInterval? = null, val ackInterval: AckInterval? = null, val transferLimit: TransferLimit? = null, val transferLimitTimer: TransferLimitTimer? = null, val supervisionPeriod: SupervisionPeriod? = null, val dataServerAddress: IpAddressOrHostname? = null, val dataServerPort: Port? = null, val dataEndpoint: String? = null, val configurationEndpoint: String? = null, val extendedConfigurationEndpoint: String? = null, val deviceInfoEndpoint: String? = null, val timeEndpoint: String? = null, val updateServerAddress: IpAddressOrHostname? = null, val updateServerPortUdp: Port? = null, val updateServerPortCoap: Port? = null, val cloudTokenConfiguration: CloudTokenConfiguration? = null, val cloudTokenCoapOption: CloudTokenCoapOption? = null, val payloadSignatureCoapOption: PayloadSignatureCoapOption? = null, val modemIdentificationCoapOption: ModemIdentificationCoapOption? = null, val dnsIp: IpAddress? = null, val dnsConfiguration: DnsConfiguration? = null, val networkTroubleshootingEnabled: Boolean? = null, val networkKey: String? = null, val apn: Apn? = null, val plmn: Plmn? = null, val modemBands: List<CellularBand>? = null, val cellularConfiguration: CellularConfiguration? = null, val networkSearch: NetworkSearch? = null, val ledConfiguration: LedConfiguration? = null)

Configuration settings for a sensor device.

Each configuration field is optional, meaning only the fields that need to be changed should be set. To clear string values, set them to an empty string. To clear other values, see the specific field documentation.

Constructors

Link copied to clipboard
constructor(serialNumber: String? = null, payloadSplitInfo: Int? = null, configurationHash: Int? = null, configurationHashTimestamp: Long? = null, configurationErrors: ConfigurationErrors? = null, measurementTypes: Map<Channel, Measurement.Type>? = null, nvmStatus: NVMStatus? = null, currentTime: Long? = null, acceptWithoutTestingRequest: Boolean? = null, configurationRequest: Boolean? = null, deviceInfoRequest: Boolean? = null, extendedConfigurationRequest: Boolean? = null, updateSoftwareRequest: Boolean? = null, clearRuntimeErrorsRequest: Boolean? = null, disableModemAfterTimeRequest: Int? = null, updateModemRequest: String? = null, resetMemoryRequest: Boolean? = null, restartMemoryStatsRequest: Boolean? = null, dataTransferStartTimestampRequest: Long? = null, setOutputControlStateRequest: Map<Channel, Boolean>? = null, measurementPeriod: MeasurementPeriod? = null, bluetoothTurnoff: BluetoothTurnOff? = null, bluetoothTxPowerLevel: TxPowerLevel? = null, encryptionKey: String? = null, bluetoothAdvertisingMode: BluetoothAdvertisingMode? = null, advertisementManufacturerDataFormat: AdvertisementManufacturerDataFormat? = null, rules: List<Rule>? = null, ruleCalendars: List<RuleCalendar>? = null, transmissionInterval: TransmissionInterval? = null, ackInterval: AckInterval? = null, transferLimit: TransferLimit? = null, transferLimitTimer: TransferLimitTimer? = null, supervisionPeriod: SupervisionPeriod? = null, dataServerAddress: IpAddressOrHostname? = null, dataServerPort: Port? = null, dataEndpoint: String? = null, configurationEndpoint: String? = null, extendedConfigurationEndpoint: String? = null, deviceInfoEndpoint: String? = null, timeEndpoint: String? = null, updateServerAddress: IpAddressOrHostname? = null, updateServerPortUdp: Port? = null, updateServerPortCoap: Port? = null, cloudTokenConfiguration: CloudTokenConfiguration? = null, cloudTokenCoapOption: CloudTokenCoapOption? = null, payloadSignatureCoapOption: PayloadSignatureCoapOption? = null, modemIdentificationCoapOption: ModemIdentificationCoapOption? = null, dnsIp: IpAddress? = null, dnsConfiguration: DnsConfiguration? = null, networkTroubleshootingEnabled: Boolean? = null, networkKey: String? = null, apn: Apn? = null, plmn: Plmn? = null, modemBands: List<CellularBand>? = null, cellularConfiguration: CellularConfiguration? = null, networkSearch: NetworkSearch? = null, ledConfiguration: LedConfiguration? = null)

Properties

Link copied to clipboard

Specifies whether the device should accept the configuration without functional testing (e.g., network connection. Sent only by the user/server.

Link copied to clipboard

Acknowledgment interval configuration.

Link copied to clipboard

Format of the manufacturer data in Bluetooth advertisements.

Link copied to clipboard
val apn: Apn?

Access Point Name (APN) for the cellular modem.

Link copied to clipboard

Bluetooth advertising mode.

Link copied to clipboard

Bluetooth turnoff configuration. When this setting is received, Bluetooth is turned off after the set number of seconds.

Link copied to clipboard

Bluetooth transmission power level.

Link copied to clipboard

Cellular configuration for the modem.

Link copied to clipboard

Device will clear all runtime errors. Sent only by the user/server.

Link copied to clipboard

Cloud token CoAP option for the device.

Link copied to clipboard

Cloud token configuration for the device.

Link copied to clipboard

Endpoint for the configuration server. Up to 15 characters.

Link copied to clipboard

Errors in the current configuration. Sent only by the device.

Link copied to clipboard

Identifier of the current configuration. Changes with each modification. Sent only by the device.

Link copied to clipboard

Timestamp (Unix epoch) of the configuration set time. Sent only by the device.

Link copied to clipboard

Specifies whether to send the configuration from the sensor to the configuration endpoint. Sent only by the user/server.

Link copied to clipboard

Current time in Unix epoch format. Sent only by the user/server.

Link copied to clipboard

Endpoint for the data server. Up to 15 characters.

Link copied to clipboard

IPv4/URL address of the data server. Up to 31 characters.

Link copied to clipboard

Port of the data server.

Link copied to clipboard

Specifies whether to send measurements from the sensor starting at the specified timestamp. All previous measurements will be marked as sent. Sent only by the user/server.

Link copied to clipboard

Endpoint for the device information server. Up to 15 characters.

Link copied to clipboard

Specifies whether to send the device information from the sensor to the device information endpoint. Sent only by the user/server.

Link copied to clipboard

Device will power off its cellular modem for requested number of seconds. Range: 60:604800 (1 minute : 7 days). Sent only by the user/server.

Link copied to clipboard

DNS server configuration.

Link copied to clipboard

DNS server IP address. Set 255.255.255.255 to use a cellular network DNS server.

Link copied to clipboard

Encryption key for the sensor. Max 16 characters. If empty, the encryption is disabled.

Link copied to clipboard

Endpoint for the extended configuration server. Up to 15 characters.

Link copied to clipboard

Specifies whether to send the extended configuration from the sensor to the extended configuration endpoint. Sent only by the user/server.

Link copied to clipboard

LED configuration for the device.

Link copied to clipboard

Measurement period configuration.

Link copied to clipboard

Map of channel to measurement type. Sent only by the device.

Link copied to clipboard

List of supported cellular bands for the modem.

Link copied to clipboard

Modem identification CoAP option for the device.

Link copied to clipboard

Network key for the device. Max 16 characters. If empty, the network key is not set.

Link copied to clipboard

Network search configuration for the modem.

Link copied to clipboard

If Bluetooth is turned off and communication with the server is faulty, Bluetooth will be automatically turned on until the connection is stabilized.

Link copied to clipboard

Status of the non-volatile memory (NVM). To clear NVM, set it to NVMStatus.OK.

Link copied to clipboard

Payload signature CoAP option for the device.

Link copied to clipboard

Information about payload splitting. Sent only by the device.

Link copied to clipboard
val plmn: Plmn?

PLMN selection for the cellular modem.

Link copied to clipboard

Device will erase all measurements from memory. Sent only by the user/server.

Link copied to clipboard

Device will restart the collection of memory statistics. Sent only by the user/server.

Link copied to clipboard

Calendars used in the edge logic rules. Up to 6 calendars supported.

Link copied to clipboard
val rules: List<Rule>?

Edge logic rules set on the device. Up to 12 rules supported.

Link copied to clipboard

Serial number of the device. Sent only by the device.

Link copied to clipboard

Device will set the new output state of the output control channel pins. Up to 3 channels supported in the one request. Sent only by the user/server.

Link copied to clipboard

Supervision period configuration.

Link copied to clipboard

Endpoint for the time server. Up to 15 characters.

Link copied to clipboard

Transfer limit configuration.

Link copied to clipboard

Transfer limit timer configuration.

Link copied to clipboard

Transmission interval in seconds. Range: 60:604800.

Link copied to clipboard

Specifies, if the modem firmware update is available. Up to 48 characters:. Sent only by the user/server.

Link copied to clipboard

IPv4/URL address of the update server. Up to 31 characters.

Link copied to clipboard

CoAP port of the update server.

Link copied to clipboard

UDP port of the update server.

Link copied to clipboard

Specifies, if software update is available. Sent only by the user/server.