<?xml version="1.0" encoding="UTF-8"?>
<!--
FILE INFORMATION

OMA Permanent Document
   File: OMA-SUP-XML_10-V1_1-20201110-A.xml
   Path: http://www.openmobilealliance.org/release/ObjLwM2M_Cell_Conn/

OMNA LwM2M Registry
   Path: https://github.com/OpenMobileAlliance/lwm2m-registry
   Name: 10.xml

NORMATIVE INFORMATION

  This file is not part of a Technical Specification document.

  Send comments to https://github.com/OpenMobileAlliance/OMA_LwM2M_for_Developers/issues

LEGAL DISCLAIMER

  Copyright 2020 Open Mobile Alliance.

  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions
  are met:

  1. Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in the
  documentation and/or other materials provided with the distribution.
  3. Neither the name of the copyright holder nor the names of its
  contributors may be used to endorse or promote products derived
  from this software without specific prior written permission.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  POSSIBILITY OF SUCH DAMAGE.

  The above license is used as a license under copyright only.  Please
  reference the OMA IPR Policy for patent licensing terms:
  https://www.omaspecworks.org/about/intellectual-property-rights/
  
-->

<LWM2M xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://openmobilealliance.org/tech/profiles/LWM2M-v1_1.xsd">
	<Object ObjectType="MODefinition">
		<Name>LWM2M Cellular Connectivity</Name>
		<Description1><![CDATA[This object specifies resources to enable a device to connect to a 3GPP or 3GPP2 bearer, including GPRS/EDGE, UMTS, LTE, NB-IoT, SMS. For cellular connectivity, this object focuses on Packet Switched (PS) connectivity and doesn't aim to provide comprehensive Circuit Switched (CS) connectivity management.]]></Description1>
		<ObjectID>10</ObjectID>
		<ObjectURN>urn:oma:lwm2m:oma:10:1.1</ObjectURN>
		<LWM2MVersion>1.1</LWM2MVersion>
		<ObjectVersion>1.1</ObjectVersion>
		<MultipleInstances>Single</MultipleInstances>
		<Mandatory>Optional</Mandatory>
		<Resources>
			<Item ID="0"><Name>SMSC address</Name>
				<Operations>RW</Operations>
				<MultipleInstances>Single</MultipleInstances>
				<Mandatory>Optional</Mandatory>
				<Type>String</Type>
				<RangeEnumeration/>
				<Units/>
				<Description><![CDATA[E.164 address of SMSC.
				Applicable for 3GPP2 networks where SMSC is not available from a smart card, or for 3GPP/3GPP2 networks to provide the application with a customer specific SMSC.  The application decides how to use this parameter, e.g. precedence over UICC based SMSC address.]]></Description>
			</Item>
			<Item ID="1"><Name>Disable radio period</Name>
				<Operations>RW</Operations>
				<MultipleInstances>Single</MultipleInstances>
				<Mandatory>Optional</Mandatory>
				<Type>Integer</Type>
				<RangeEnumeration>0..65535</RangeEnumeration>
				<Units/>
				<Description><![CDATA[Time period in MINUTES for which the device shall disconnect from cellular radio (PS detach, CS detach if applicable).
				Can be used to handle network overload situations. 
				The value is a positive integer (0 to 65535), duration can be from 1 minute to 65535 minutes (approximately 45 days)
				As soon the server writes a value which is >0 the device SHALL disconnect. When the period has elapsed the device MAY reconnect.]]></Description>
			</Item>
			<Item ID="2"><Name>Module activation code</Name>
				<Operations>RW</Operations>
				<MultipleInstances>Single</MultipleInstances>
				<Mandatory>Optional</Mandatory>
				<Type>String</Type>
				<RangeEnumeration/>
				<Units/>
				<Description><![CDATA[Configurable in case the application needs to issue a code (e.g. via AT command) to activate the module. e.g. "*98".]]></Description>
			</Item>
			<Item ID="3"><Name>Vendor specific extensions</Name>
				<Operations>R</Operations>
				<MultipleInstances>Single</MultipleInstances>
				<Mandatory>Optional</Mandatory>
				<Type>Objlnk</Type>
				<RangeEnumeration/>
				<Units/>
				<Description><![CDATA[Links to a vendor specific object.]]></Description>
			</Item>
			<Item ID="4"><Name>PSM Timer</Name>
				<Operations>RW</Operations>
				<MultipleInstances>Single</MultipleInstances>
				<Mandatory>Optional</Mandatory>
				<Type>Integer</Type>
				<RangeEnumeration/>
				<Units>s</Units>
				<Description><![CDATA[PSM Timer = Extended T3412 as described in section 10.5.7.4a (GPRS Timer 3) of [3GPP-TS_24.008]. The value in seconds has to be compatible with Extended T3412, otherwise conversion will not be exact. It defines Max interval between periodic TAU if there is no other transmission from the device. During most of this time the device is considered as unreachable and can therefore go into a deep sleep mode while keeping the PDN connection(s) active.]]></Description>
			</Item>
			<Item ID="5"><Name>Active Timer</Name>
				<Operations>RW</Operations>
				<MultipleInstances>Single</MultipleInstances>
				<Mandatory>Optional</Mandatory>
				<Type>Integer</Type>
				<RangeEnumeration/>
				<Units>s</Units>
				<Description><![CDATA[Active Timer = T3324 as described in section 10.5.7.3 (GPRS Timer) of [3GPP-TS_24.008]. The value in seconds has to be compatible with T3324, otherwise conversion will not be exact. This is the time a UE has to remain reachable after transitioning to idle state in case there is pending data from the NW to send out. At the end of T3324 UE can go into a deep sleep mode while keeping the PDN connection(s) active.]]></Description>
			</Item>
			<Item ID="7"><Name>eDRX parameters for Iu mode</Name>
				<Operations>RW</Operations>
				<MultipleInstances>Single</MultipleInstances>
				<Mandatory>Optional</Mandatory>
				<Type>Opaque</Type>
				<RangeEnumeration>0..255</RangeEnumeration>
				<Units/>
				<Description><![CDATA[Extended DRX parameters (Paging Time Window and eDRX value) for Iu mode which the UE can request from the network. This resource is encoded as octet 3 in [3GPP-TS_24.008, clause 10.5.5.32].]]></Description>
			</Item>
			<Item ID="8"><Name>eDRX parameters for WB-S1 mode</Name>
				<Operations>RW</Operations>
				<MultipleInstances>Single</MultipleInstances>
				<Mandatory>Optional</Mandatory>
				<Type>Opaque</Type>
				<RangeEnumeration>0..255</RangeEnumeration>
				<Units/>
				<Description><![CDATA[Extended DRX parameters (Paging Time Window and eDRX value) for WB-S1 mode which the UE can request from the network. This resource is encoded as octet 3 in [3GPP-TS_24.008, clause 10.5.5.32].]]></Description>
			</Item>
			<Item ID="9"><Name>eDRX parameters for NB-S1 mode</Name>
				<Operations>RW</Operations>
				<MultipleInstances>Single</MultipleInstances>
				<Mandatory>Optional</Mandatory>
				<Type>Opaque</Type>
				<RangeEnumeration>0..255</RangeEnumeration>
				<Units/>
				<Description><![CDATA[Extended DRX parameters (Paging Time Window and eDRX value) for NB-S1 mode which the UE can request from the network. This resource is encoded as octet 3 in [3GPP-TS_24.008, clause 10.5.5.32].]]></Description>
			</Item>
			<Item ID="10"><Name>eDRX parameters for A/Gb mode</Name>
				<Operations>RW</Operations>
				<MultipleInstances>Single</MultipleInstances>
				<Mandatory>Optional</Mandatory>
				<Type>Opaque</Type>
				<RangeEnumeration>0..255</RangeEnumeration>
				<Units/>
				<Description><![CDATA[Extended DRX parameters (Paging Time Window and eDRX value) for A/Gb mode which the UE can request from the network. This resource is encoded as octet 3 in [3GPP-TS_24.008, clause 10.5.5.32].]]></Description>
			</Item>
			<Item ID="11"><Name>Activated Profile Names</Name>
				<Operations>R</Operations>
				<MultipleInstances>Multiple</MultipleInstances>
				<Mandatory>Mandatory</Mandatory>
				<Type>Objlnk</Type>
				<RangeEnumeration/>
				<Units/>
				<Description><![CDATA[Links to instances of the "APN connection profile" object representing every APN connection profile that has an activated PDN connection.]]></Description>
			</Item>
			<Item ID="12">
				<Name>Supported Power Saving Modes</Name>
				<Operations>R</Operations>
				<MultipleInstances>Single</MultipleInstances>
				<Mandatory>Optional</Mandatory>
				<Type>Unsigned Integer</Type>
				<RangeEnumeration>0..255</RangeEnumeration>
				<Units />
				<Description><![CDATA[This Resource is used to indicate the Power Saving Modes supported by the LwM2M Client.
				Each bit set in the Resource Instance value corresponds to a supported mode. Several bit set, means several modes are supported.
				1st LSB: PSM
				2nd LSB: eDRX
				Other bits are reserved for future use]]></Description>
			</Item>
			<Item ID="13">
				<Name>Active Power Saving Modes</Name>
				<Operations>RW</Operations>
				<MultipleInstances>Single</MultipleInstances>
				<Mandatory>Optional</Mandatory>
				<Type>Unsigned Integer</Type>
				<RangeEnumeration>0..255</RangeEnumeration>
				<Units />
				<Description><![CDATA[This Resource is used to indicate which Power Saving Mode(s) is (are) currently active in the LwM2M Client.
				Each bit set in the Resource Instance value corresponds to an active mode.
				1st LSB: PSM 
				2nd LSB: eDRX
				Other bits are reserved for future use]]></Description>
			</Item>
			<Item ID="14">
				<Name>Release Assistance Indication Usage</Name>
				<Operations>RW</Operations>
				<MultipleInstances>Single</MultipleInstances>
				<Mandatory>Optional</Mandatory>
				<Type>Unsigned Integer</Type>
				<RangeEnumeration>0..255</RangeEnumeration>
				<Units />
				<Description><![CDATA[This resource is used to indicate client configuration as to when it uses Release Assistance Indicator (RAI) as defined in 3GPP-TS_24.310, clause 9.9.4.25 to indicate to the NW when connection can be released.
				1st LSB: RAI not used
				2nd LSB: RAI used when transmitting last message which requires no application/transport layer response/ confirmation
				3rd LSB: RAI used when transmitting last message which requires response/confirmation; when this bit is set, 2nd LSB is also expected to be set.]]></Description>
			</Item>
		</Resources>
		<Description2><![CDATA[Notes:
                (0) Resource 6 "Serving PLMN Rate control" was moved to the APN Connection Profile Object (#11) to correctly correspond to the 3GPP specifications.

		(1) PSM Timer, Active Timer and all eDRX parameters resources are controlled by the 3GPP network. A LwM2M server may write a suggested values to these resource. As soon a LwM2M server changes the current values the device then suggests the new values to the network upon the next practical opportunity e.g. by inclusion of the requested value in an Attach or TAU request. In case the network confirms the suggested value then the device shall apply that value. In case the network provides a different value then the value provided by the network shall be applied by the device and the resource value shall be set to that value.
		The LwM2M server may use the observe function to be notified upon any changes of PSM, Active timer or eDRX parameters. By using the observe function the LwM2M server will get notified in case the value suggested by the LwM2M server is not accepted by the network, or, if the value is changed by the network for any reason (e.g., if the device moves into new tracking areas there is no guarantee that the above values remain the same and are not altered by the network).]]></Description2>
	</Object>
</LWM2M>