7.3 Data formats for device configuration
7.3.1 Introduction
Clause 7.3 defines data formats of resource attributes and parameters used in present document.
Any data types of XML elements defined for use in present document shall be one of name spaces in table 7.3.1-1.
Table 7.3.1-1: Namespaces used in present document
| Name space | prefix | Namespace definition |
|---|---|---|
| oneM2M protocol CDT | m2m: | http://www.onem2m.org/xml/protocol |
| Device Configuration | dcfg: | http://www.onem2m.org/xml/deviceConfig |
| oneM2M Security | sec: | http://www.onem2m.org/xml/securityProtocols |
7.3.2 Simple oneM2M data types for device configuration
Table 7.3.2-1 describes simple data type definitions specific to security. The types in table 7.3.2-1 are either:
- Atomic data types derived from XML Schema data types by restrictions other than enumeration.
- List data types constructed from other XML Schema or oneM2M-defined atomic data types.
Table 7.3.2-1: oneM2M simple data types for device configuration
| XSD type name | Used for | Examples | Description |
|---|---|---|---|
| dcfg:TLSCiphersuite | A TLS Ciphersuite identifier | C0A5 | Four hexadecimal characters representing a TLS Cipher suite identifier. The list of TLS cipher suites identifiers can be found at the IANA TLS Cipher Suite Registry [8]. |
| dcfg:ListOfTLSCiphersuite | A list of TLS Ciphersuite identifiers | xs:list of elements of data type dcfg:TLSCiphersuite. | |
| dcfg:niURI | Identifying information with a hash value | ni:///sha-256;UyaQV... ni:///1;UyaQV... ("1" is a short identifier for sha-256) |
An xs:anyURI conforming to the Named Information 'ni' URI scheme specified in IETF RFC 6920 [7], with no authority field. |
| dcfg:nihURI | Identifying information with a human speakable encoding of a hash value | nih:sha-256-32;53269057;b nih:sha-256-32;5326-9057;b nih:6;5326-9057 ("6" is a short identifier for sha-256-32) |
An xs:anyURI conforming to the Human Speakable Named Information 'nih' URI scheme specified in IETF RFC 6920 [7], with no authority field. A checkdigit may be present. |
| dcfg:ssid | SSID of Wi-Fi® network | The ssid of Wi-Fi® network. | |
| dcfg:listOfSsids | List of SSIDs | xs:list of elements of data type m2m:ssid. | |
| dcfg:imsi | IMSI of a SIM | 262019876543210 | IMSI compliant numerical representation |
| dcfg:iccid | ICCID of a SIM | 89490200000829149056 | ICCID alphanumerical representation |
| dcfg:apn | APN of a cellular network | internet.t-mobile | xs:string with an internal format that follows the structure of an APN (Access Point Name). It usually consists of a network identifier and an operator identifier. See [14]. |
| dcfg:lac | Location Area Code for a cellular network | 0x0523 | A Location Area Code is a fixed length code of 2 octets identifying a location area. The data type is xs:integer. |
7.3.3 Enumerated oneM2M data types for device configuration
7.3.3.1 dcfg:wifiConnectionStatus
Used to indicate Wi-Fi® connection status.
Table 7.3.3.11: Interpretation of dcfg:wifiConnectionStatus
| Value | Interpretation | Note |
|---|---|---|
| 0 | Disconnected | |
| 1 | Connected | |
| 2 | Idle | Indicates the state when the device tries to establish the connection to the network. It expires after the set number of unsuccessful attempts or when the connection is established. |
| 3 | No SSID available | |
| 4 | Scan completed | |
| 5 | Failed | |
| 6 | Lost |
7.3.3.2 dcfg:wifiEncryptionType
Used for indicating which Wi-Fi® encryption protocol is used to provide security in wireless network.
Table 7.3.3.2-1: Interpretation of dcfg:wifiEncyrptionType
| Value | Interpretation | Note |
|---|---|---|
| 1 | none | |
| 2 | WEP | |
| 3 | WPA Personal | |
| 4 | WPA2 Personal | |
| 5 | WPA3 Personal | |
| 6 | WPA Enterprise | |
| 7 | WPA2 Enterprise | |
| 8 | WPA3 Enterprise |
7.3.3.3 dcfg:simStatus
Used for indicating a SIM status.
Table 7.3.3.3-1: Interpretation of dcfg:simStatus
| Value | Interpretation | Note |
|---|---|---|
| 0 | inactive | |
| 1 | active |
7.3.3.4 dcfg:simType
Used for indicating a SIM type.
Table 7.3.3.4-1: Interpretation of dcfg:simType
| Value | Interpretation | Note |
|---|---|---|
| 0 | UICC (removable) | |
| 1 | eUICC (removable) | |
| 2 | eUICC (non-removable) | |
| 3 | iUICC |
7.3.3.5 dcfg:cellularNetworkBearerType
Used for indicating a Cellular Network Bearer type.
Table 7.3.3.5-1: Interpretation of dcfg:cellularNetworkBearerType
| Value | Interpretation | Note |
|---|---|---|
| 0 | GSM cellular network | |
| 1 | TD-SCDMA cellular network | |
| 2 | WCDMA cellular network | |
| 3 | CDMA2000 cellular network | |
| 4 | WiMAX cellular network | |
| 5 | LTE-TDD cellular network | |
| 6 | LTE-FDD cellular network | |
| 7 | NB-IoT |
7.3.3.6 dcfg:coverageEnhancementLevel
Used for indicating a Coverage Enhancement Level.
Table 7.3.3.6-1: Interpretation of dcfg:coverageEnhancementLevel
| Value | Interpretation | Note |
|---|---|---|
| 0 | No Coverage Enhancement in the serving cell | |
| 1 | Coverage Enhancement level 0 | |
| 2 | Coverage Enhancement level 1 | |
| 3 | Coverage Enhancement level 2 | |
| 4 | Coverage Enhancement level 3 |
7.3.4 Complex type definitions
7.3.4.1 dcfg:wifiCredentials
Used for credentials in [wifiClient] Management Object resource. Values contained in username, password, wep.key and wpa.psk attributes shall not be readable. Each Retrieve request shall be forwarded to device and from there the data shall be retrieved.
Table 7.3.4.1-1: Type Definition of dcfg:wifiCredentials
| Element Path | Element Data Type | Multiplicity | Note |
|---|---|---|---|
| encryptionType | dcfg:wifiEncryptionType | 1 | Indicates type of encryption used to provide network security |
| username | xs:string | 0..1 | Indicates username used to authenticate user in WPA-Enterprise, WPA2-Enterprise or WPA3-Enterprise protocols Only valid if encryptionType=6,7 or 8 |
| password | xs:string | 0..1 | Indicates password used to authenticate user in WPA-Enterprise, WPA2-Enterprise or WPA3-Enterprise protocols Only valid if encryptionType=6,7 or 8 |
| wepKey | xs:string | 0..1 | Indicates key in case of WEP encryption. Only valid if field encryptionType =2 |
| wpaPsk | xs:string | 0..1 | Indicates WPA Pre Shared Key Only valid if field encryptionType = 3,4 or 5 |