Package-level declarations

Types

Link copied to clipboard
enum Action : Enum<Action>

Represents action to be triggered when specified Condition is met.

Link copied to clipboard

Represents advertisement manufacturer specific data format.

data class AmbientLightDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>

Differential threshold on an Measurement.Type.AMBIENT_LIGHT channel.

data class AmbientLightLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>

High or low threshold on an Measurement.Type.AMBIENT_LIGHT channel.

data class AmmoniaDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on an Measurement.Type.AMMONIA channel.

data class AmmoniaLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on an Measurement.Type.AMMONIA channel.

data class AtmosphericPressureDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>

Differential threshold on an Measurement.Type.ATMOSPHERIC_PRESSURE channel.

data class AtmosphericPressureLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>

High or low threshold on an Measurement.Type.ATMOSPHERIC_PRESSURE channel.

Link copied to clipboard
data class BatteryStatistics(val batteryStatus: BatteryStatistics.BatteryStatus, val batteryVoltage: Int, val mcuTemperature: Int, val batteryMinVoltage: Int, val batteryMinTemperature: Int, val batteryResetTimestamp: Long, val mcuMaxTemperature: Int, val mcuMinTemperature: Int)

Represents battery statistics information

Link copied to clipboard

Triggers on every change of a binary channel's state. Binary sensors only. See Type.BINARY_STATE_CHANGED.

Link copied to clipboard
sealed interface BluetoothAdvertisingMode

Represents the advertising mode for Bluetooth sensors.

Link copied to clipboard
sealed interface BluetoothTurnOff

Bluetooth turn off configuration. It can be set to always on or after specified time. Note that if the BLE interface is switched off, it is impossible to access the sensor through the mobile application.

data class BreathVOCDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on a Measurement.Type.BREATH_VOC channel.

data class BreathVOCLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on a Measurement.Type.BREATH_VOC channel.

data class CarbonDioxideDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on a Measurement.Type.CARBON_DIOXIDE channel.

data class CarbonDioxideEquivalentDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on a Measurement.Type.CARBON_DIOXIDE_EQUIVALENT channel.

data class CarbonDioxideEquivalentLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on a Measurement.Type.CARBON_DIOXIDE_EQUIVALENT channel.

data class CarbonDioxideLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on a Measurement.Type.CARBON_DIOXIDE channel.

data class CarbonMonoxideDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on a Measurement.Type.CARBON_MONOXIDE channel.

data class CarbonMonoxideLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on a Measurement.Type.CARBON_MONOXIDE channel.

Link copied to clipboard
sealed class Condition

Represents condition to be checked by the device. If the condition is true, an Action is triggered.

Link copied to clipboard
sealed interface ConditionParameters

Parameters a ParametrizedCondition is evaluated with.

Link copied to clipboard
data class ConfigurationErrors(val lastErrorTimestamp: Long?, val errors: List<Int>)

Represents information about device configuration errors

data class CurrentDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>

Differential threshold on a Measurement.Type.CURRENT channel.

data class CurrentLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>

High or low threshold on a Measurement.Type.CURRENT channel.

data class CurrentPreciseDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>

Differential threshold on a Measurement.Type.CURRENT_PRECISE channel.

data class CurrentPreciseLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>

High or low threshold on a Measurement.Type.CURRENT_PRECISE channel.

data class DewPointDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>

Differential threshold on a Measurement.Type.DEW_POINT channel.

data class DewPointLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>

High or low threshold on a Measurement.Type.DEW_POINT channel.

data class DifferentialPressureDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on a Measurement.Type.DIFFERENTIAL_PRESSURE channel.

data class DifferentialPressureLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on a Measurement.Type.DIFFERENTIAL_PRESSURE channel.

Link copied to clipboard

Triggers once the measured value has moved far enough from the last value sent to the server. See Type.DIFFERENTIAL_THRESHOLD.

Link copied to clipboard

Parameters of a differential threshold condition. Continuous channels only.

Triggers once the combined value of a major and minor channel pair has moved far enough from the last value sent to the server. See Type.DIFFERENTIAL_THRESHOLD_DUAL_CHANNEL.

Parameters of a differential threshold condition on a major and minor channel pair.

Link copied to clipboard

Condition is disabled, so the rule never triggers. See Type.DISABLED.

data class DistanceDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on a Measurement.Type.DISTANCE channel.

data class DistanceLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on a Measurement.Type.DISTANCE channel.

data class ElectricityUsageAccumulatedLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>

High or low threshold on an Measurement.Type.ELECTRICITY_USAGE_ACCUMULATED channel.

data class ElectricityUsageDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on an Measurement.Type.ELECTRICITY_USAGE channel.

data class ElectricityUsageLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on an Measurement.Type.ELECTRICITY_USAGE channel.

data class HeatIndexDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>

Differential threshold on a Measurement.Type.HEAT_INDEX channel.

data class HeatIndexLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>

High or low threshold on a Measurement.Type.HEAT_INDEX channel.

data class HighPressureDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on a Measurement.Type.HIGH_PRESSURE channel.

data class HighPressureLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on a Measurement.Type.HIGH_PRESSURE channel.

Link copied to clipboard

Triggers while the measured value is above the threshold. See Type.HIGH_THRESHOLD.

Link copied to clipboard

Triggers while the combined value of a major and minor channel pair is above the threshold. See Type.HIGH_THRESHOLD_DUAL_CHANNEL.

data class HumidityAccurateDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>

Differential threshold on a Measurement.Type.HUMIDITY_ACCURATE channel.

data class HumidityAccurateLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>

High or low threshold on a Measurement.Type.HUMIDITY_ACCURATE channel.

data class HumidityDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on a Measurement.Type.HUMIDITY channel.

data class HumidityLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on a Measurement.Type.HUMIDITY channel.

data class HydrogenSulfideDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>

Differential threshold on a Measurement.Type.HYDROGEN_SULFIDE channel.

data class HydrogenSulfideLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>

High or low threshold on a Measurement.Type.HYDROGEN_SULFIDE channel.

data class InternalAirQualityDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on an Measurement.Type.INTERNAL_AIR_QUALITY channel.

data class InternalAirQualityLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on an Measurement.Type.INTERNAL_AIR_QUALITY channel.

data class InternalAirQualityStaticDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on an Measurement.Type.INTERNAL_AIR_QUALITY_STATIC channel.

data class InternalAirQualityStaticLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on an Measurement.Type.INTERNAL_AIR_QUALITY_STATIC channel.

Link copied to clipboard
data class LedConfiguration(val greenLedPeriod: Int, val redLedPeriod: Int, val communicationErrorLedTurnoffTime: Int, val sensorErrorLedTurnoffTime: Int, val lowPowerLedTurnoffTime: Int, val newMeasurementLedTurnoffTime: Int, val transmissionLedTurnoffTime: Int, val sensorOkLedTurnoffTime: Int, val blinkTime: Int)

Represents device LEDs configuration

Link copied to clipboard

Operator combining the states of several rules.

Link copied to clipboard

Combines the states of other rules with a logic operator. See Type.LOGIC_OPERATOR.

Link copied to clipboard
data class LogicOperatorConditionParameters(val logicOperator: LogicOperator, val selectedRules: Set<Int>, val negatedRules: Set<Int>, val actionDelay: Int?, val returnDelay: Int?) : ConditionParameters

Parameters of a logic operator condition.

Link copied to clipboard

Parameters of a high or low threshold condition. Continuous channels only.

Parameters of a high or low threshold condition on a major and minor channel pair.

Link copied to clipboard

Triggers while the measured value is below the threshold. See Type.LOW_THRESHOLD.

Link copied to clipboard

Triggers while the combined value of a major and minor channel pair is below the threshold. See Type.LOW_THRESHOLD_DUAL_CHANNEL.

Link copied to clipboard
data class MeasurementsPacket(val period: Int, val periodFactor: Int?, val measurements: List<MeasurementsPacket.TimestampedMeasurement>)

Packet of measurements having the same period and periodFactor.

Link copied to clipboard
data class MemoryStatistics(val nvStorageStatus: MemoryStatistics.NvStorageStatus, val collectingTimestamp: Long?, val capacityInBytes: Int, val usedSpaceInBytes: Int, val invalidPacketsSizeInBytes: Int, val corruptedPacketsSizeInBytes: Int, val validPacketsNumber: Int, val invalidPacketsNumber: Int, val corruptedPacketsNumber: Int, val samplesNumber: Map<Channel, Int>, val firstBinaryMeasurementTimestamp: Long?, val lastBinaryMeasurementTimestamp: Long?, val lastSentBinaryMeasurementTimestamp: Long?, val firstContinuousMeasurementTimestamp: Long?, val lastContinuousMeasurementTimestamp: Long?, val lastSentContinuousMeasurementTimestamp: Long?, val nvmWriteCounter: Int?)

This data class holds information about the sensor device's memory statistics.

data class MethaneDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on a Measurement.Type.METHANE channel.

data class MethaneLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on a Measurement.Type.METHANE channel.

data class NitrogenDioxideDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on a Measurement.Type.NITROGEN_DIOXIDE channel.

data class NitrogenDioxideLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on a Measurement.Type.NITROGEN_DIOXIDE channel.

data class NoiseLevelDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>

Differential threshold on a Measurement.Type.NOISE_LEVEL channel.

data class NoiseLevelLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>

High or low threshold on a Measurement.Type.NOISE_LEVEL channel.

Link copied to clipboard

Represents non-volatile memory status.

Link copied to clipboard

Triggers after a measurement is taken, optionally only every n-th one. See Type.ON_MEASUREMENT.

Link copied to clipboard
data class OnMeasurementConditionParameters(val measurementInterval: Int, val selectedRules: Set<Int>, val negatedRules: Set<Int>) : ConditionParameters

Parameters of an on-measurement condition.

Link copied to clipboard

Triggers while the sensor reports an error instead of a measurement. Sensors v7 only. See Type.ON_SENSOR_ERROR.

Link copied to clipboard

Condition that needs parameters to be evaluated, such as a threshold to compare against.

data class ParticulateMatter10DifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on a Measurement.Type.PM10 channel.

data class ParticulateMatter10LowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on a Measurement.Type.PM10 channel.

data class ParticulateMatter1DifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on a Measurement.Type.PM1 channel.

data class ParticulateMatter1LowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on a Measurement.Type.PM1 channel.

data class ParticulateMatter2_5DifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on a Measurement.Type.PM2_5 channel.

data class ParticulateMatter2_5LowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on a Measurement.Type.PM2_5 channel.

data class PercentageDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>

Differential threshold on a Measurement.Type.PERCENTAGE channel.

data class PercentageLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>

High or low threshold on a Measurement.Type.PERCENTAGE channel.

data class PulsesAccumulatedDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on a Measurement.Type.PULSES_ACCUMULATED channel.

data class PulsesAccumulatedLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on a Measurement.Type.PULSES_ACCUMULATED channel.

data class PulsesAccumulatedWideDifferentialThresholdConditionParameters(val thresholdValue: Long, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Long>

Differential threshold on a single Measurement.Type.PULSES_ACCUMULATED_WIDE channel. See PulsesAccumulatedWideDifferentialThresholdDualChannelConditionParameters for the major and minor channel pair.

Threshold is a combined value of the major and minor channels: combined = major * 1_000_000 + minor.

data class PulsesAccumulatedWideLowHighThresholdConditionParameters(val thresholdValue: Long, val hysteresisValue: Long?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Long>

High or low threshold on a single Measurement.Type.PULSES_ACCUMULATED_WIDE channel. See PulsesAccumulatedWideLowHighThresholdDualChannelConditionParameters for the major and minor channel pair.

Threshold and hysteresis are combined values of the major and minor channels: combined = major * 1_000_000 + minor.

data class PulsesDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on a Measurement.Type.PULSES channel.

data class PulsesLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on a Measurement.Type.PULSES channel.

data class ResistanceDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on a Measurement.Type.RESISTANCE channel.

data class ResistanceLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on a Measurement.Type.RESISTANCE channel.

data class RmsCurrentDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on a Measurement.Type.RMS_CURRENT channel.

data class RmsCurrentLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on a Measurement.Type.RMS_CURRENT channel.

Link copied to clipboard
data class Rule(val id: Int, val channels: Set<Channel>, val condition: Condition, val action: Action)

Represents rule used to define edge logic on the device.

Link copied to clipboard
data class RuleCalendar(val id: Int, val selectedRules: Set<Int>, val type: RuleCalendar.Type)

Rule calendar is used for enabling/disabling rules based on date/time.

Link copied to clipboard
sealed class RuntimeError

Represents error the sensor recorded while running.

Link copied to clipboard
data class RuntimeInfo(val upTime: Int, val messageCounters: RuntimeInfo.MessageCounters, val batteryVoltage: Int?, val mcuTemperature: Int, val maxMcuTemperature: Int, val minMcuTemperature: Int, val runtimeErrors: List<RuntimeError>, val resetCounter: Int)

This data class holds information about the sensor device's runtime state.

Link copied to clipboard
data class SelfTestData(val availableTests: List<SelfTestData.Test>, val externalFlashInfo: SelfTestData.ExternalFlashInfo?, val batteryVoltage: Double, val measurements: Map<Int, Measurement<*>>, val buttonState: SelfTestData.ButtonState?, val imei: String?, val iccid: String?, val modemVersion: String?, val modemApplicationVersion: String?)
Link copied to clipboard
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 correlatedChannels: Map<Channel, List<Channel>>? = 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 enableChannelsRequest: List<Channel>? = 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.

Link copied to clipboard

Represents an error related to sensor configuration.

Link copied to clipboard
data class SensorDeviceInfo(val serialNumber: String, val softwareVersion: SoftwareVersion, val runtimeInfo: RuntimeInfo, val memoryStatistics: MemoryStatistics, val lastUpdateInfo: UpdateInfo, val modem: Modem?)

This data class represents the information retrieved from a sensor device.

Link copied to clipboard
data class SensorExtendedConfiguration(val serialNumber: String? = null, val configurationHash: Int? = null, val laboratoryCalibrationTimestamp: Long? = null, val channelCalibration: Map<Channel, Calibration>? = null, val sensorName: String? = null)

Extended configuration settings for a sensor device.

Link copied to clipboard
data class SensorHardwareVersion(val powerSupply: SensorHardwareVersion.PowerSupplyType, val communicationInterface: SensorHardwareVersion.CommunicationInterface, val features: Set<SensorHardwareVersion.DeviceFeature>, val hardwareVersion: String, val model: String)

Represents the hardware version of a sensor device.

Link copied to clipboard

Represents notification used by legacy sensors

Link copied to clipboard

Represents information about sensor installed on the device

Link copied to clipboard
sealed class SensorNotification

Represents notification used by sensors

data class SoilMoistureDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on a Measurement.Type.SOIL_MOISTURE channel.

data class SoilMoistureLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on a Measurement.Type.SOIL_MOISTURE channel.

data class TemperatureDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>

Differential threshold on a Measurement.Type.TEMPERATURE channel.

data class TemperatureLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>

High or low threshold on a Measurement.Type.TEMPERATURE channel.

Link copied to clipboard
data class TimeInformation(val timeStamp: Long, val event: TimeInformation.Event, val elapsedSecondsSinceEvent: Long, val measurementSynchronizationFinished: Sensor.TimeSynchronizationStatus?, val timeSynchronizationPeriodInSeconds: Int?)

Represents the time the sensor is keeping and what last set it.

Link copied to clipboard

How the device processes samples before comparing them against a threshold.

Link copied to clipboard

Represents the transmission (tx) power level of bluetooth module installed on the sensor.

Link copied to clipboard

Condition is not specified. See Type.UNSPECIFIED.

Link copied to clipboard
data class UpdateInfo(val timestamp: Long, val status: UpdateInfo.Status?)

This class holds information about the last update of the sensor device.

data class VoltageDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>

Differential threshold on a Measurement.Type.VOLTAGE channel.

data class VoltageLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>

High or low threshold on a Measurement.Type.VOLTAGE channel.

data class WaterUsageAccumulatedDifferentialThresholdConditionParameters(val thresholdValue: Double, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Double>

Differential threshold on a Measurement.Type.WATER_USAGE_ACCUMULATED channel.

data class WaterUsageAccumulatedLowHighThresholdConditionParameters(val thresholdValue: Double, val hysteresisValue: Double?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Double>

High or low threshold on a Measurement.Type.WATER_USAGE_ACCUMULATED channel.

data class WaterUsageDifferentialThresholdConditionParameters(val thresholdValue: Int, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : DifferentialThresholdConditionParameters<Int>

Differential threshold on a Measurement.Type.WATER_USAGE channel.

data class WaterUsageLowHighThresholdConditionParameters(val thresholdValue: Int, val hysteresisValue: Int?, val triggeringMode: TriggeringMode, val triggeringMeasurementsCount: Int) : LowHighThresholdConditionParameters<Int>

High or low threshold on a Measurement.Type.WATER_USAGE channel.