bluetooth/pl.efento.mobile.bluetooth.model.gateway/GatewayConfiguration

GatewayConfiguration

data class GatewayConfiguration(val serialNumber: String? = null, val hash: Int? = null, val hashTimestamp: Long? = null, val payloadSplitInfo: Int? = null, val newPassword: String? = null, val encryptionKey1: String? = null, val encryptionKey2: String? = null, val encryptionKey3: String? = null, val encryptionKey4: String? = null, val ipAddress: IpAddress? = null, val subnetMask: NetMask? = null, val defaultGatewayIp: IpAddress? = null, val dhcpEnabled: Boolean? = null, val phyMode: GatewayConfiguration.PhyMode? = null, val plmn: Plmn? = null, val apn: Apn? = null, val dnsIp: IpAddress? = null, val ntpAddress: IpAddressOrHostname? = null, val proxyAddress: IpAddressOrHostname? = null, val proxyPort: Port? = null, val proxyUsername: String? = null, val proxyPassword: String? = null, val proxyType: GatewayConfiguration.ProxyType? = null, val dataServerAddress: IpAddressOrHostname? = null, val dataServerPort: Port? = null, val dataServerTlsEnabled: Boolean? = null, val dataServerToken: String? = null, val dataServerApiVersion: GatewayConfiguration.DataServerApiVersion? = null, val dataSyncEnabled: Boolean? = null, val heartbeatSendingInterval: Int? = null, val simCardPin: String? = null, val sensorNotificationsEnabled: Boolean? = null)

Configuration settings for a Gateway 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.

Constructors

GatewayConfiguration

constructor(serialNumber: String? = null, hash: Int? = null, hashTimestamp: Long? = null, payloadSplitInfo: Int? = null, newPassword: String? = null, encryptionKey1: String? = null, encryptionKey2: String? = null, encryptionKey3: String? = null, encryptionKey4: String? = null, ipAddress: IpAddress? = null, subnetMask: NetMask? = null, defaultGatewayIp: IpAddress? = null, dhcpEnabled: Boolean? = null, phyMode: GatewayConfiguration.PhyMode? = null, plmn: Plmn? = null, apn: Apn? = null, dnsIp: IpAddress? = null, ntpAddress: IpAddressOrHostname? = null, proxyAddress: IpAddressOrHostname? = null, proxyPort: Port? = null, proxyUsername: String? = null, proxyPassword: String? = null, proxyType: GatewayConfiguration.ProxyType? = null, dataServerAddress: IpAddressOrHostname? = null, dataServerPort: Port? = null, dataServerTlsEnabled: Boolean? = null, dataServerToken: String? = null, dataServerApiVersion: GatewayConfiguration.DataServerApiVersion? = null, dataSyncEnabled: Boolean? = null, heartbeatSendingInterval: Int? = null, simCardPin: String? = null, sensorNotificationsEnabled: Boolean? = null)

Types

DataServerApiVersion

enum DataServerApiVersion : Enum<GatewayConfiguration.DataServerApiVersion>

enum PhyMode : Enum<GatewayConfiguration.PhyMode>

enum ProxyType : Enum<GatewayConfiguration.ProxyType>

Properties

val apn: Apn?

Access Point Name (APN) for the Modem interface. Length: Up to 49 characters.

dataServerAddress

val dataServerAddress: IpAddressOrHostname?

Data server address (IP/URL). Length: Up to 63 characters.

dataServerApiVersion

val dataServerApiVersion: GatewayConfiguration.DataServerApiVersion?

API version for measurements from the data server.

val dataServerPort: Port?

Data server port. Range: 1:65535.

dataServerTlsEnabled

val dataServerTlsEnabled: Boolean?

TLS state for communication with the data server (enabled/disabled).

dataServerToken

val dataServerToken: String?

Data server token. Length: Up to 36 characters.

dataSyncEnabled

val dataSyncEnabled: Boolean?

Data synchronization state (enabled/disabled). Enabling this will save sensors' measurements added to Efento Cloud in the gateway's internal memory.

defaultGatewayIp

val defaultGatewayIp: IpAddress?

Default gateway IPv4 address for the Ethernet interface.

val dhcpEnabled: Boolean?

DHCP state (enabled/disabled) for the Ethernet interface.

val dnsIp: IpAddress?

DNS IPv4 address.

val encryptionKey1: String?

1st encryption key. Length: Up to 16 characters.

val encryptionKey2: String?

2nd encryption key. Length: Up to 16 characters.

val encryptionKey3: String?

3rd encryption key. Length: Up to 16 characters.

val encryptionKey4: String?

4th encryption key. Length: Up to 16 characters.

val hash: Int?

Identifier of the current configuration. This value changes with each modification to the configuration. This field is only sent by the device.

val hashTimestamp: Long?

Timestamp when the new configuration was set (Unix epoch). The value is 0 if the device has not fetched the real time.

heartbeatSendingInterval

val heartbeatSendingInterval: Int?

Interval for sending heartbeat (gateway status) to the server, in minutes. Range: 1:65535.

val ipAddress: IpAddress?

IPv4 address for the Ethernet interface.

val newPassword: String?

New gateway password (only sent by the user). Length: Up to 16 characters.

val ntpAddress: IpAddressOrHostname?

NTP server address (IP/URL). Length: Up to 63 characters.

payloadSplitInfo

val payloadSplitInfo: Int?

Information about payload splitting:

val phyMode: GatewayConfiguration.PhyMode?

PHY mode for the Ethernet interface.

val plmn: Plmn?

PLMN selection for the Modem interface.

val proxyAddress: IpAddressOrHostname?

Proxy address (IP/URL). Length: Up to 47 characters.

val proxyPassword: String?

Proxy password. Length: Up to 16 characters.

val proxyPort: Port?

Proxy port. Range: 1:65535.

val proxyType: GatewayConfiguration.ProxyType?

Proxy type (no proxy, basic authentication, or no authentication).

val proxyUsername: String?

Proxy username. Length: Up to 31 characters.

sensorNotificationsEnabled

val sensorNotificationsEnabled: Boolean?

Sensor notifications state (enabled/disabled). Enabling this option will cause sensors notifications to be sent over bluetooth.

val serialNumber: String?

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

val simCardPin: String?

SIM card PIN code. Length: Up to 8 characters. Set to an empty string to not use a SIM card PIN code.

val subnetMask: NetMask?

Subnet mask for the Ethernet interface.