New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →

lwm2m-id

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

lwm2m-id

lwm2m-id is a module that implements a dictionary of ip-based smart object(IPSO) identifiers defined by lwm2m spec.

1.0.2
Source
npm

Version published: 9 years ago

Weekly downloads: 505; increased by7.91%

Maintainers: 1

Weekly downloads

Created: 9 years ago

Source

lwm2m-id

## Table of Contents

1. Overview

lwm2m-id is a dictionary of identifiers defined by OMA LightweightM2M(v1.0) and IPSO SmartObject Guideline(Smart Objects Starter Pack1.0). Please visit their websites for more information.

2. Installation

$ npm install lwm2m-id --save

3. Usage

lwm2m-id provides you with two getters, i.e. getOid() and getRid(), to get the key-value pair of an Object and a Resource identifier. The getter returns an item which has properties of 'key' and 'value', or returns undefined if not found. In the returned item, item.key is the idetifier in string and item.value is the identifier in number. Let me show you some examples.

var m2mid = require('lwm2m-id')

// get Object Id
var oidItem1 = m2mid.getOid('device');      // { key: 'device', value: 3 }
var oidItem2 = m2mid.getOid(3);             // { key: 'device', value: 3 }
var oidItem3 = m2mid.getOid('3');           // { key: 'device', value: 3 }
var oidItem4 = m2mid.getOid(999);           // undefined
var oidItem5 = m2mid.getOid('noSuchId');    // undefined

var oidKey = m2mid.getOid(3).key;           // 'device'
var oidId = m2mid.getOid('device').value;   // 3

// get Resource Id
//   (1) The rid is specific to an Object
var ridItem1 = m2mid.getRid('lightCtrl', 'onOff');    // { key: 'onOff', value: 5850 }
var ridItem2 = m2mid.getRid(3311, 'onOff');           // { key: 'onOff', value: 5850 }
var ridItem3 = m2mid.getRid(3311, 5850);              // { key: 'onOff', value: 5850 }
var ridItem4 = m2mid.getRid('3311', '5850');          // { key: 'onOff', value: 5850 }
var ridItem5 = m2mid.getOid('lightCtrl', 'noSuchId'); // undefined
var ridItem6 = m2mid.getOid('noSuchId', 5850);        // undefined

var ridKey = m2mid.getRid('lightCtrl', 5850).key;     // 'onOff'
var ridId = m2mid.getRid(3311, 'onOff').value;        // 5850

//   (2) The rid is an unique id
var ridItem7 = m2mid.getRid('sensorValue');           // { key: 'sensorValue', value: 5700 }
var ridItem8 = m2mid.getRid(5700);                    // { key: 'sensorValue', value: 5700 }
var ridItem8 = m2mid.getRid('5700');                  // { key: 'sensorValue', value: 5700 }

var ridKey = m2mid.getRid(5700).key;                  // 'sensorValue'
var ridId = m2mid.getRid('sensorValue').value;        // 5700

4. APIs

.getOid(oid)

Returns an item of the Object identifier.

Arguments

oid (String|Number): oid can be given with a string or a number. Notice that a numbered string will be recognized as a number, e.g. '128' is equal to 128.

Returns:

(Object | Undefined) Returns an item of { key: 'sampleId', value: 1234 }, otherwise returns undefined if not found.

Example

lwm2mid.getOid('tempSensor');   // { key: 'tempSensor', value: 3303 }
lwm2mid.getOid(3303);           // { key: 'tempSensor', value: 3303 }
lwm2mid.getOid('3303');         // { key: 'tempSensor', value: 3303 }

lwm2mid.getOid('xxxx');         // undefined 
lwm2mid.getOid('9999');         // undefined 
lwm2mid.getOid(9999);           // undefined

.getRid([oid,] rid)

Returns an item of the Resource identifier.

There are two kinds of Resource id, the Resource id specific to an Object and the unique Resource id. In the former case, the meaning of a Resource is specific to an Object that holds it. An unique Resource id indicates that the Resouce id is a reusable one and its id number is always constant and unique across Objects. In addition, an Object can use both of these two kinds of Resource id to define its characteristic.

To query a Resource id specific to an Object, both oid and rid should be given.
To query an unique Resource id, only the single argument rid is needed.

Arguments

oid (String|Number, optional): oid can be given with a string or a number. Notice that a numbered string will be recognized as a number, e.g. '128' is equal to 128.
rid (String|Number): rid can be given with a string or a number. Notice that a numbered string will be recognized as a number, e.g. '128' is equal to 128.

Example

// get a Resource id specific to an Object
lwm2mid.getRid('tempSensor', 'sensorValue');   // { key: 'sensorValue', value: 5700 }
lwm2mid.getRid(3303, 5700);                    // { key: 'sensorValue', value: 5700 }
lwm2mid.getRid('tempSensor', '5700');          // { key: 'sensorValue', value: 5700 }

// get an unqiue Resource id
lwm2mid.getRid('appType');                     // { key: 'appType', value: 5750 }
lwm2mid.getRid(5750);                          // { key: 'appType', value: 5700 }
lwm2mid.getRid('5750');                        // { key: 'appType', value: 5750 }

5. Table of Identifiers

IPSO/OMA-LWM2M Object ids

Object Id	lwm2m-id Key	Description/Object Name
0	lwm2mSecurity	LWM2M Security
1	lwm2mServer	LWM2M Server
2	accessControl	Access Control
3	device	Device
4	connMonitor	Connectivity Monitoring
5	firmware	Firmware
6	location	Location
7	connStatistics	Connectivity Statistics
8	lockAndWipe	Lock and Wipe
9	swUpdate	Sofware Update
10	cellularConn	Cellular connectivity
11	apnConnProfile	APN connection profile
12	wlanConn	WLAN connectivity
13	bearerSelection	Bearer selection
15	devCapMgmt	DevCapMgmt
2048	cmdhPolicy	CmdhPolicy
2049	activeCmdhPolicy	ActiveCmdhPolicy
2050	cmdhDefaults	CmdhDefaults
2051	cmdhDefEcValues	CmdhDefEcValues
2052	cmdhDefEcParamsValues	CmdhDefEcParamsValues
2053	cmdhLimits	CmdhLimits
2054	cmdhNetworkAccessRules	CmdhNetworkAccessRules
2055	cmdhNwAccessRule	CmdhNwAccessRule
2056	cmdhBuffer	CmdhBuffer
3200	digitalInput	Digital Input
3201	digitalOutput	Digital Output
3202	analogInput	Analogue Input
3203	analogOutput	Analogue Output
3300	genericSensor	Generic Sensor
3301	presenceSensor	Illuminance Sensor
3302	presenceSensor	Presence Sensor
3303	tempSensor	Temperature Sensor
3304	humidSensor	Humidity Sensor
3305	pwrMea	Power Measurement
3306	actuation	Actuation
3308	setPoint	Set Point
3310	loadCtrl	Load Control
3311	lightCtrl	Light Control
3312	pwrCtrl	Power Control
3313	accelerometer	Accelerometer
3314	magnetometer	Magnetometer
3315	barometer	Barometer

IPSO/OMA-LWM2M unique Resource ids (this class of ids is reusable with Objects)

Resource Id	lwm2m-id Key	Resource Name
4000	objectInstanceHandle
4001	objectVersion
5500	dInState
5501	counter
5502	dInPolarity
5503	debouncePeriod
5504	edgeSelection
5505	counterReset
5550	dOutState
5551	dOutpolarity
5600	aInCurrValue
5601	minMeaValue
5602	maxMeaValue
5603	minRangeValue
5604	maxRangeValue
5605	resetMinMaxMeaValues
5650	aOutCurrValue
5700	sensorValue
5701	units
5702	xValue
5703	yValue
5704	zValue
5705	compassDir
5706	colour
5750	appType
5751	sensorType
5800	instActivePwr
5801	minMeaActivePwr
5802	maxMeaActivePwr
5803	minRangeActivePwr
5804	maxRangeActivePwr
5805	cumulActivePwr
5806	activePwrCal
5810	instReactivePwr
5811	minMeaReactivePwr
5812	maxMeaReactivePwr
5813	minRangeReactivePwr
5814	maxRangeReactivePwr
5815	cumulReactivePwr
5816	reactivePwrCal
5820	pwrFactor
5821	currCal
5822	resetCumulEnergy
5823	eventId
5824	startTime
5825	durationInMin
5826	criticalLevel
5827	avgLoadAdjPct
5828	dutyCycle
5850	onOff
5851	dimmer
5852	onTime
5853	mstateOut
5900	setPointValue
5903	busyToClearDelay
5904	clearToBusyDelay
5905	hostDeviceManuf
5906	hostDeviceMdl
5907	hostDeviceUID
5908	hostDeviceSwVer

IPSO/OMA-LWM2M specified Resource ids (this class of ids is specified with Objects)

oid = lwm2mSecurity

    {
        "lwm2mServerURI": 0,
        "bootstrapServer": 1,
        "securityMode": 2,
        "pubKeyId": 3,
        "serverPubKeyId": 4,
        "secretKey": 5,
        "smsSecurityMode": 6,
        "smsBindingKeyParam": 7,
        "smsBindingSecretKey": 8,
        "lwm2mServerSmsNum": 9,
        "shortServerId": 10,
        "clientHoldOffTime": 11
    }

oid = lwm2mServer

    {
        "shortServerId": 0,
        "lifetime": 1,
        "defaultMinPeriod": 2,
        "defaultMaxPeriod": 3,
        "disable": 4,
        "disableTimeout": 5,
        "notificationStoring": 6,
        "binding": 7,
        "regUpdateTrigger": 8
    }

oid = accessControl

    {
        "objectId": 0,
        "objectInstanceId": 1,
        "ACL": 2,
        "ACLOwner": 3
    }

oid = device

        "manuf": 0,
        "model": 1,
        "serial": 2,
        "firmware": 3,
        "reboot": 4,
        "factoryReset": 5,
        "availPwrSrc": 6,
        "pwrSrcVoltage": 7,
        "pwrSrcCurrent": 8,
        "battLevel": 9,
        "memFree": 10,
        "errCode": 11,
        "resetErrCode": 12,
        "currTime": 13,
        "UTCOffset": 14,
        "timezone": 15,
        "suppBindAndMode": 16,
        "devType": 17,
        "hwVer": 18,
        "swVer": 19,
        "battStatus": 20,
        "memTotal": 21

oid = connMonitor

    {
        "nwkBearer": 0,
        "availNwkBearer": 1,
        "radioSS": 2,
        "linkQuality": 3,
        "ip": 4,
        "routeIp": 5,
        "linkUtil": 6,
        "APN": 7,
        "cellId": 8,
        "SMNC": 9,
        "SMCC": 10
    }

oid = firmware

    {
        "package": 0,
        "packageURI": 1,
        "update": 2,
        "state": 3,
        "updateSuppObjects": 4,
        "updateResult": 5,
        "pkgName": 6,
        "pkgVer": 7
    }

oid = location

    {
        "lat": 0,
        "lon": 1,
        "alt": 2,
        "uncertainty": 3,
        "velocity": 4,
        "timestamp": 5
    }

oid = connStatistics

    {
        "SMSTxCounter": 0,
        "SMSRxCounter": 1,
        "txData": 2,
        "rxData": 3,
        "maxMsgSize": 4,
        "avgMsgSize": 5,
        "startOrReset": 6
    }

oid = digitalInput

    {
        "dInState": 5500,
        "counter": 5501,
        "dInPolarity": 5502,
        "debouncePeriod": 5503,
        "edgeSelection": 5504,
        "counterReset": 5505,
        "appType": 5750,
        "sensorType": 5751
    }

oid = digitalOutput

    {
        "dOutState": 5550,
        "dOutpolarity": 5551,
        "appType": 5750
    }

oid = analogInput

    {
        "aInCurrValue": 5600,
        "minMeaValue": 5601,
        "maxMeaValue": 5602,
        "minRangeValue": 5603,
        "maxRangeValue": 5604,
        "resetMinMaxMeaValues": 5605,
        "appType": 5750,
        "sensorType": 5751
    }

oid = analogOutput

    {
        "aOutCurrValue": 5650,
        "minRangeValue": 5603,
        "maxRangeValue": 5604,
        "appType": 5750
    }

oid = genericSensor

    {
        "sensorValue": 5700,
        "units": 5701,
        "minMeaValue": 5601,
        "maxMeaValue": 5602,
        "minRangeValue": 5603,
        "maxRangeValue": 5604,
        "resetMinMaxMeaValues": 5605,
        "appType": 5750,
        "sensorType": 5751
    }

oid = illumSensor

    {
        "sensorValue": 5700,
        "units": 5701,
        "minMeaValue": 5601,
        "maxMeaValue": 5602,
        "minRangeValue": 5603,
        "maxRangeValue": 5604,
        "resetMinMaxMeaValues": 5605
    }

oid = presenceSensor

    {
        "dInState": 5500,
        "counter": 5501,
        "counterReset": 5505,
        "sensorType": 5751,
        "busyToClearDelay": 5903,
        "clearToBusyDelay": 5904
    }

oid = tempSensor

    {
        "sensorValue": 5700,
        "units": 5701,
        "minMeaValue": 5601,
        "maxMeaValue": 5602,
        "minRangeValue": 5603,
        "maxRangeValue": 5604,
        "resetMinMaxMeaValues": 5605
    }

oid = humidSensor

    {
        "sensorValue": 5700,
        "units": 5701,
        "minMeaValue": 5601,
        "maxMeaValue": 5602,
        "minRangeValue": 5603,
        "maxRangeValue": 5604,
        "resetMinMaxMeaValues": 5605
    }

oid = pwrMea

    {
        "instActivePwr": 5800,
        "minMeaActivePwr": 5801,
        "maxMeaActivePwr": 5802,
        "minRangeActivePwr": 5803,
        "maxRangeActivePwr": 5804,
        "cumulActivePwr": 5805,
        "activePwrCal": 5806,
        "instReactivePwr": 5810,
        "minMeaReactivePwr": 5811,
        "maxMeaReactivePwr": 5812,
        "minRangeReactivePwr": 5813,
        "maxRangeReactivePwr": 5814,
        "resetMinMaxMeaValues": 5605,
        "cumulReactivePwr": 5815,
        "reactivePwrCal": 5816,
        "pwrFactor": 5820,
        "currCal": 5821,
        "resetCumulEnergy": 5822
    }

oid = actuation

    {
        "onOff": 5850,
        "dimmer": 5851,
        "onTime": 5852,
        "mstateOut": 5853,
        "appType": 5750
    }

oid = setPoint

    {
        "setPointValue": 5900,
        "colour": 5706,
        "units": 5701,
        "appType": 5750
    }

oid = loadCtrl

    {
        "eventId": 5823,
        "startTime": 5824,
        "durationInMin": 5825,
        "criticalLevel": 5826,
        "avgLoadAdjPct": 5827,
        "dutyCycle": 5828
    }

oid = lightCtrl

    {
        "onOff": 5850,
        "dimmer": 5851,
        "colour": 5706,
        "units": 5701,
        "onTime": 5852,
        "cumulActivePwr": 5805,
        "pwrFactor": 5820
    }

oid = pwrCtrl

    {
        "onOff": 5850,
        "dimmer": 5851,
        "onTime": 5852,
        "cumulActivePwr": 5805,
        "pwrFactor": 5820
    }

oid = accelerometer

    {
        "units": 5701,
        "xValue": 5702,
        "yValue": 5703,
        "zValue": 5704,
        "minRangeValue": 5603,
        "maxRangeValue": 5604
    }

oid = magnetometer

    {
        "units": 5701,
        "xValue": 5702,
        "yValue": 5703,
        "zValue": 5704,
        "compassDir": 5705
    }

oid = barometer

    {
        "sensorValue": 5700,
        "units": 5701,
        "minMeaValue": 5601,
        "maxMeaValue": 5602,
        "minRangeValue": 5603,
        "maxRangeValue": 5604,
        "resetMinMaxMeaValues": 5605
    }

Keywords

FAQs

What is lwm2m-id?

Is lwm2m-id popular?

Is lwm2m-id well maintained?

Package last updated on 01 Feb 2016

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install