Reserved and Deprecated Fields
ReferenceAudience: API consumerUse: check whether a member or value you use is deprecated, reserved, or unsupported
This page lists everything in contract version 1.22.0 that is still accepted but that you should not build new behavior on. When a removal schedule or notice period is not stated below, it is not specified in the available sources.
Deprecated Members
The contract marks no member with the deprecated keyword. These members are deprecated by their descriptions or by the contract's own examples:
| Member | Where it appears | What to do |
|---|---|---|
autoConn | Wi-Fi access-point settings in set_wifi and the get_wifi response | Don't rely on it. The contract states that it is reserved for backward compatibility and will be removed. |
wifiConfig at the top level of a reply | The get_wifi response, in the contract's WiFi interface disabled example | The schema declares only wifiProfiles, a list. Parse both shapes. |
Reserved Members
Of the event switches, only seven take effect on current firmware. The others are accepted, stored and returned in read-backs, but they have no effect: no event is produced and no threshold is applied. The API developer has declared them for future support; the contract itself does not mark them.
| Object | Reserved members |
|---|---|
cfgEventPayload, used by config_events and endpoint eventConfiguration | antenna, gpi, exceptions, ntp, userApp, temperature, cpuUsage, flashUsage, ramUsage, cpuThreshold, ramThreshold, flashThreshold, temperatureThreshold |
The members that take effect are battery, fileDownload, firmwareUpdate, heartbeat, network, power, and terminalConnection.
Unsupported Members and Values
| Member or value | Status |
|---|---|
DATA2 endpoint type, and DATA_EP2 | Currently not supported. Use a DATA1 endpoint and DATA_EP1. |
heartbeatConfiguration.userApps | Not functional on current firmware. No heartbeat carries user-application status. |
FAST_READ operating-mode profile in set_operating_mode | The contract describes the profile as not currently supported, and states that data events are not currently supported with it. |
PFX certificate format | The enum lists it, but the contract states that only PEM is currently supported. |
powerSource values | Each value is reported only in some messages. See powerSource. |
Names Removed from the Contract
| Name | Status |
|---|---|
set_eth, cloud_connect, config_alerts | No longer part of the contract. No message carries these command names. |
Related: 📕 Versioning and Compatibility · 📕 Enumerations · 📕 config_events