This class represents device (endpoint).
\nThis class represents REST API service.
\nRepresents LwM2M variable (identifier) types (OBJECT_INSTANCE,\nMULTIPLE_RESOURCE, RESOURCE_INSTANCE, RESOURCE).
\nRepresents resource type (NONE, BOOLEAN, INTEGER, FLOAT, STRING, OPAQUE).
\nObject | string | numberGets dictionary by given name of the key and value.
\nobjectEncodes value of the resource.
\nObject | string | number | booleanDecodes value of the resource.
\nobjectEncodes ant type of instance (Object instance, multiple resources, resources instance, resource).
\nobjectEncodes resource instance to TLV buffer.
\nobjectEncodes multiple resource values to TLV buffer.
\nobjectEncodes resource to TLV buffer.
\nobjectEncodes LwM2M object instance to TLV buffer.
\nobjectEncodes LwM2M object to TLV buffer.
\nobjectDecodes any TLV buffer.
\nobjectDecodes resource instance.
\nobjectDecodes resource instance value
\nobjectDecodes resource.
\nobjectDecodes object instance from TLV buffer.
\nobjectDecodes LwM2M object to TLV buffer.
\nPromise\n * [.read(path, callback)](#Device+read) ⇒ Promise\n * [.write(path, callback, payload, type)](#Device+write) ⇒ Promise\n * [.execute(path, callback, payload, type)](#Device+execute) ⇒ Promise\n * [.observe(path, callback)](#Device+observe) ⇒ Promise\n * [.cancelObserve(path)](#Device+cancelObserve) ⇒ Promise\n\n\n\n### new Device(service, id)\nConstructor initiliazes given service object, device's id\nand starts listening for events emited by service (when device\nregisters, updates, deregisters, sends data), handles \"async\nresponses\" and emits \"register\", \"update\", \"deregister\" events.\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| service | object | Service object |\n| id | string | Endpoint id |\n\n**Example** \n```js\nconst restAPI = require('restserver-api');\n\nconst service = new restAPI.Service(serviceOptions);\nconst device = new restAPI.Device(service, 'deviceId');\n```\n\n\n### device.getObjects() ⇒ Promise\nSends request to get all device's objects.\n\n**Kind**: instance method of [Device](#Device) \n**Returns**: Promise - Promise object with device's objects \n**Example** \n```js\ndevice.getObjects().then((resp) => {\n // resp = [ { uri: '/1/0' }, { uri: '/2/0' }, ... ]\n}).catch((err) => {\n // err - exception message object or status code\n});\n```\n\n\n### device.read(path, callback) ⇒ Promise\nSends request to read device's resource data.\n\n**Kind**: instance method of [Device](#Device) \n**Returns**: Promise - Promise with async response id \n\n| Param | Type | Description |\n| --- | --- | --- |\n| path | string | Resource path |\n| callback | function | Callback which will be called when async response is received |\n\n**Example** \n```js\ndevice.read(path, (status, payload) => {\n // status = 200\n // payload = 4RbaAA==\n}).then((asyncResponseId) => {\n // asyncResponseId = 1533889157#42f26784-1a8d-4861-36aa-d88f\n}).catch((err) => {\n // err - exception object or status code\n});\n```\n\n\n### device.write(path, callback, payload, type) ⇒ Promise\nSends request to write a value into device's resource.\n\n**Kind**: instance method of [Device](#Device) \n**Returns**: Promise - Promise with async response id \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| path | string | | Resource path |\n| callback | function | | Callback which will be called when async response is received |\n| payload | buffer | | Data (optional) |\n| type | string | "application/vnd.oma.lwm2m+tlv" | Content type (optional) |\n\n**Example** \n```js\ndevice.write(path, (status) => {\n // status = 202\n}, payload).then((asyncResponseId) => {\n // asyncResponseId = 1533889926#870a3f17-3e21-b6ad-f63d-5cfe\n}).catch((err) => {\n // err - exception object or status code\n});\n```\n\n\n### device.execute(path, callback, payload, type) ⇒ Promise\nSends request to execute device's resource.\n\n**Kind**: instance method of [Device](#Device) \n**Returns**: Promise - Promise with async response id \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| path | string | | Resource path |\n| callback | function | | Callback which will be called when async response is received |\n| payload | buffer | | Data (optional) |\n| type | string | "text/plain" | Content type (optional) |\n\n**Example** \n```js\ndevice.execute(path, (status) => {\n // status = 202\n}).then((asyncResponseId) => {\n // asyncResponseId = 1533889926#870a3f17-3e21-b6ad-f63d-5cfe\n}).catch((err) => {\n // err - exception object or status code\n});\n```\n\n\n### device.observe(path, callback) ⇒ Promise\nSends request to subscribe to resource.\n\n**Kind**: instance method of [Device](#Device) \n**Returns**: Promise - Promise with async response id \n\n| Param | Type | Description |\n| --- | --- | --- |\n| path | string | Resource path |\n| callback | function | Callback which will be called when async response is received |\n\n**Example** \n```js\ndevice.observe(path, (status, payload) => {\n // status = 200\n // payload = 4RbaAA==\n}).then((asyncResponseId) => {\n // asyncResponseId = 1533889157#42f26784-1a8d-4861-36aa-d88f\n}).catch((err) => {\n // err - exception object or status code\n});\n```\n\n\n### device.cancelObserve(path) ⇒ Promise\nSends request to cancel subscriptions.\n\n**Kind**: instance method of [Device](#Device) \n**Returns**: Promise - Promise with HTTP status code \n\n| Param | Type | Description |\n| --- | --- | --- |\n| path | string | Resource path |\n\n**Example** \n```js\ndevice.cancelObserve(path).then((status) => {\n // status - status code\n}).catch((err) => {\n // err - exception object\n});\n```\n\n\n## Service\nThis class represents REST API service.\n\n**Kind**: global class \n\n* [Service](#Service)\n * [new Service(opts)](#new_Service_new)\n * [.start(opts)](#Service+start) ⇒ Promise\n * [.stop()](#Service+stop) ⇒ Promise\n * [.authenticate()](#Service+authenticate) ⇒ Promise\n * [.registerNotificationCallback()](#Service+registerNotificationCallback) ⇒ Promise\n * [.deleteNotificationCallback()](#Service+deleteNotificationCallback) ⇒ Promise\n * [.checkNotificationCallback()](#Service+checkNotificationCallback) ⇒ Promise\n * [.pullNotification()](#Service+pullNotification) ⇒ Promise\n * [.getDevices()](#Service+getDevices) ⇒ Promise\n * [.getVersion()](#Service+getVersion) ⇒ Promise\n * [.get(path)](#Service+get) ⇒ Promise\n * [.put(path, argument, type)](#Service+put) ⇒ Promise\n * [.delete(path)](#Service+delete) ⇒ Promise\n * [.post(path, argument, type)](#Service+post) ⇒ Promise\n\n\n\n### new Service(opts)\nInitializes default configurations. Reconfigures with given options.\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| opts | object | Options object (optional) |\n\n**Example** \n```js\nconst options = {\n // REST server's address\n host: 'http://localhost:8888',\n // CA certificate\n ca: '',\n // authentication (true or false)\n authentication: false,\n username: '',\n password: '',\n // notification polling (true or false)\n polling: false,\n // time between each poll in miliseconds\n interval: 1234,\n // port for socket listener (not relevant if polling is enabled)\n port: 5728,\n};\nnew Service(options);\n```\n\n\n### service.start(opts) ⇒ Promise\n(Re)starts authentication,\nsocket listener creation and notification callback registration\nor notification polling processes.\n\n**Kind**: instance method of [Service](#Service) \n**Returns**: Promise - Promise which fulfills when service is started \n\n| Param | Type | Description |\n| --- | --- | --- |\n| opts | object | Options object (optional) |\n\n**Example** \n```js\nservice.start().then(() => {\n // started service\n}).catch((err) => {\n // err - exception object\n});\n```\n**Example** *(Passing options object)* \n```js\nconst options = {\n // REST server's address\n host: 'http://localhost:8888',\n // CA certificate\n ca: '',\n // authentication (true or false)\n authentication: false,\n username: '',\n password: '',\n // notification polling (true or false)\n polling: false,\n // time between each poll in miliseconds\n interval: 1234,\n // port for socket listener (not relevant if polling is enabled)\n port: 5728,\n};\nservice.start(options);\n```\n\n\n### service.stop() ⇒ Promise\nStops receiving and processing events\nStops this service and all it's subservices\nthat were started in start().\nCleans up resources\n\n**Kind**: instance method of [Service](#Service) \n**Returns**: Promise - Promise which fulfills when service is stopped \n**Example** \n```js\nservice.stop().then(() => {\n // stopped service\n});\n```\n\n\n### service.authenticate() ⇒ Promise\nSends request to authenticate user.\n\n**Kind**: instance method of [Service](#Service) \n**Returns**: Promise - Promise with authentication data (token and after what time it expires) \n**Example** \n```js\nservice.authenticate().then((resp) => {\n // resp = { access_token: 'token-value', expires_in: 3600 }\n}).catch((err) => {\n // err - exception message object or status code\n});\n```\n\n\n### service.registerNotificationCallback() ⇒ Promise\nSends request to register notification callback.\n\n**Kind**: instance method of [Service](#Service) \n**Returns**: Promise - Promise which fulfills when notification callback is registered \n**Example** \n```js\nservice.registerNotificationCallback().then(() => {\n // notification callback has been registered\n}).catch((err) => {\n // err - exception object or status code\n});\n```\n\n\n### service.deleteNotificationCallback() ⇒ Promise\nSends request to delete notification callback.\n\n**Kind**: instance method of [Service](#Service) \n**Returns**: Promise - Promise with HTTP status code \n**Example** \n```js\nservice.deleteNotificationCallback().then((status) => {\n // status - status code\n}).catch((err) => {\n // err - exception object\n});\n```\n\n\n### service.checkNotificationCallback() ⇒ Promise\nSends request to check whether or not notification callback is registered.\n\n**Kind**: instance method of [Service](#Service) \n**Returns**: Promise - Promise with notification callback data \n**Example** \n```js\nservice.checkNotificationCallback().then((resp) => {\n // resp = { url: 'http://localhost:5728/notification', headers: {} }\n}).catch((err) => {\n // err - exception message object or status code\n});\n```\n\n\n### service.pullNotification() ⇒ Promise\nSends request to get pending/queued notifications.\n\n**Kind**: instance method of [Service](#Service) \n**Returns**: Promise - Promise with notification data (registrations,\nderegistrations, updates, async responses) \n**Example** \n```js\nservice.pullNotification().then((resp) => {\n // resp = { registrations: [...], 'reg-updates': [...], ... }\n}).catch((err) => {\n // err - exception object\n});\n```\n\n\n### service.getDevices() ⇒ Promise\nSends request to get all registered endpoints.\n\n**Kind**: instance method of [Service](#Service) \n**Returns**: Promise - Promise with a list of endpoints \n**Example** \n```js\nservice.getDevices().then((resp) => {\n // resp = [ { name: 'uuid-4567', type: '8dev_3700', ... }, ... ]\n}).catch((err) => {\n // err - exception message object or status code\n});\n```\n\n\n### service.getVersion() ⇒ Promise\nSends request to get REST server version.\n\n**Kind**: instance method of [Service](#Service) \n**Returns**: Promise - Promise with REST server's version \n**Example** \n```js\nservice.getVersion().then((resp) => {\n // resp = '1.0.0'\n}).catch((err) => {\n // err - exception object\n});\n```\n\n\n### service.get(path) ⇒ Promise\nPerforms GET requests with given path.\n\n**Kind**: instance method of [Service](#Service) \n**Returns**: Promise - Promise with data and response object \n\n| Param | Type | Description |\n| --- | --- | --- |\n| path | string | Request path |\n\n**Example** \n```js\nservice.get(path).then((dataAndResponse) => {\n // dataAndResponse.data - data object\n // dataAndResponse.resp - response object\n}).catch((err) => {\n // err - exception object\n});\n```\n\n\n### service.put(path, argument, type) ⇒ Promise\nPerforms PUT requests with given path, data and data type.\n\n**Kind**: instance method of [Service](#Service) \n**Returns**: Promise - Promise with data and response object \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| path | string | | Request path |\n| argument | object | | Data which will be sent (optional) |\n| type | string | "application/vnd.oma.lwm2m+tlv" | Data type (optional) |\n\n\n\n### service.delete(path) ⇒ Promise\nPerforms DELETE requests with given path.\n\n**Kind**: instance method of [Service](#Service) \n**Returns**: Promise - Promise with data and response object \n\n| Param | Type | Description |\n| --- | --- | --- |\n| path | string | Request path |\n\n\n\n### service.post(path, argument, type) ⇒ Promise\nPerforms POST requests with given path, data and data type.\n\n**Kind**: instance method of [Service](#Service) \n**Returns**: Promise - Promise with data and response object \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| path | string | | Request path |\n| argument | object | | Data which will be sent (optional) |\n| type | string | "application/vnd.oma.lwm2m+tlv" | Data type (optional) |\n\n\n\n## TYPE\nRepresents LwM2M variable (identifier) types (OBJECT_INSTANCE,\nMULTIPLE_RESOURCE, RESOURCE_INSTANCE, RESOURCE).\n\n**Kind**: global constant \n\n\n## RESOURCE_TYPE\nRepresents resource type (NONE, BOOLEAN, INTEGER, FLOAT, STRING, OPAQUE).\n\n**Kind**: global constant \n\n\n## getDictionaryByValue(dictionaryList, keyName, value) ⇒ Object \\| string \\| number\nGets dictionary by given name of the key and value.\n\n**Kind**: global function \n**Returns**: Object \\| string \\| number - dictionary \n\n| Param | Type | Description |\n| --- | --- | --- |\n| dictionaryList | object | Dictionary list. |\n| keyName | Object \\| string | Name of the key |\n| value | Object \\| string \\| number | Value |\n\n\n\n## encodeResourceValue(resource) ⇒ object\nEncodes value of the resource.\n\n**Kind**: global function \n**Returns**: object - buffer - Buffer of encoded value. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| resource | object | Object which stores resource value and value's type. |\n\n**Example** \n```js\nconst resource = {\n type: TLV.RESOURCE_TYPE.INTEGER,\n value: 1\n};\n\nconst encodedValue = encodeResourceValue(resource);\n// encodedValue = Object \\| string \\| number \\| boolean\nDecodes value of the resource.\n\n**Kind**: global function \n**Returns**: Object \\| string \\| number \\| boolean - value - Decoded value in specified type \n\n| Param | Type | Description |\n| --- | --- | --- |\n| buffer | object | Buffer which will be decoded. |\n| resource | object | Object which stores resource value's type. |\n\n**Example** \n```js\nconst buffer = Buffer.from([0x01]);\nconst resource = {\n type: TLV.RESOURCE_TYPE.INTEGER,\n};\n\nconst decodedValue = decodeResourceValue(buffer, resource);\n// decodedValue = 1\n```\n\n\n## encode(object) ⇒ object\nEncodes ant type of instance (Object instance, multiple resources, resources instance, resource).\n\n**Kind**: global function \n**Returns**: object - buffer - encoded TLV buffer. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| object | object | object which stores type, identifier and value. |\n\n**Example** \n```js\nconst resource = {\n identifier: 5850,\n type: TLV.RESOURCE_TYPE.BOOLEAN,\n value: true\n};\n\nconst encoded = encode({\n type: TYPE.RESOURCE,\n identifier: resource.identifier,\n value: encodeResourceValue(resource),\n});\n// encoded = object\nEncodes resource instance to TLV buffer.\n\n**Kind**: global function \n**Returns**: object - buffer - Buffer in TLV format \n\n| Param | Type | Description |\n| --- | --- | --- |\n| resourceInstance | object | Object which stores resource identifier, value and it's type. |\n\n**Example** \n```js\nconst resourceInstance = {\n identifier: 5850,\n type: TLV.RESOURCE_TYPE.BOOLEAN,\n value: true\n};\n\nconst encoded = encodeResourceInstance(resourceInstance);\n// encoded = object\nEncodes multiple resource values to TLV buffer.\n\n**Kind**: global function \n**Returns**: object - buffer - TLV buffer. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| resources | object | Object which stores identifier, resource type, and multiple values. |\n\n**Example** \n```js\nconst resources = {\n identifier: 5850,\n type: TLV.RESOURCE_TYPE.BOOLEAN,\n value: [true, false]\n};\n\nconst encoded = encodeMultipleResources(resources);\n// encoded = object\nEncodes resource to TLV buffer.\n\n**Kind**: global function \n**Returns**: object - buffer - TLV buffer. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| resource | object | Object which stores resource identifier, type and value. |\n\n**Example** \n```js\nconst resource = {\n identifier: 5850,\n type: TLV.RESOURCE_TYPE.BOOLEAN,\n value: true\n};\n\nconst encoded = encodeResourcez(resource);\n// encoded = object\nEncodes LwM2M object instance to TLV buffer.\n\n**Kind**: global function \n**Returns**: object - buffer - TLV buffer. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| objectInstance | object | LwM2M object. |\n\n**Example** \n```js\nconst objectInstance = {\n identifier: 0,\n resources: [\n {\n identifier: 5815,\n type: TLV.RESOURCE_TYPE.FLOAT,\n value: 999.99\n }\n ]\n};\n\nconst encoded = encodeObjectInstanceTLV(objectInstance);\n// encoded = object\nEncodes LwM2M object to TLV buffer.\n\n**Kind**: global function \n**Returns**: object - buffer - TLV buffer. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| object | object | LwM2M object. |\n\n**Example** \n```js\nconst object = {\n identifier: 3305,\n objectInstances: [{\n identifier: 0,\n resources: [\n {\n identifier: 5815,\n type: TLV.RESOURCE_TYPE.FLOAT,\n value: 999.99\n }\n ]\n }]\n};\n\nconst encoded = encodeObject(object);\n// encoded = object\nDecodes any TLV buffer.\n\n**Kind**: global function \n**Returns**: object - object - Decoded object. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| buffer | object | encoded TLV buffer. |\n\n**Example** \n```js\nconst buffer = Buffer.from([0xe1, 0x16, 0xda, 0x01]);\n\nconst decoded = TLV.decode(buffer);\n// decoded = { type: 3, identifier: 5850, value: object\nDecodes resource instance.\n\n**Kind**: global function \n**Returns**: object - decodedResource - Object which stores resource identifier,\ntlvSize resource type and value. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| buffer | object | Resource instance TLV buffer. |\n| resources | object | Object which stores resource identifier and resource type. |\n\n**Example** \n```js\nconst buffer = Buffer.from([0x61, 0x16, 0xda, 0x01]);\nconst resources = {\n identifier: 5850,\n type: TLV.RESOURCE_TYPE.BOOLEAN,\n};\n\nconst decoded = decodeResourceInstance(buffer, resources);\n// decoded = { identifier: 5850, tlvSize: 4, type: TLV.RESOURCE_TYPE.BOOLEAN, value: true }\n```\n\n\n## decodeResourceInstanceValue(buffer, resourceInstance) ⇒ object\nDecodes resource instance value\n\n**Kind**: global function \n**Returns**: object - decodedResourceValue - Decoded resource value \n\n| Param | Type | Description |\n| --- | --- | --- |\n| buffer | object | Resource instance value TLV buffer |\n| resourceInstance | object | Object which stores resource type |\n\n**Example** \n```js\nconst buffer = Buffer.from([0x01]);\nconst resourceInstance = {\n type: TLV.RESOURCE_TYPE.INTEGER,\n};\n\nconst decoded = decodeResourceInstance(buffer, resources);\n// decoded = 1\n```\n\n\n## decodeResource(buffer, resource) ⇒ object\nDecodes resource.\n\n**Kind**: global function \n**Returns**: object - buffer - Decoded resource. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| buffer | object | Resource TLV buffer |\n| resource | object | Object which stores identifier and resource type. |\n\n**Example** \n```js\nconst buffer = Buffer.from([0xe1, 0x16, 0xda, 0x01]);\nconst resource = {\n identifier: 5850,\n type: TLV.RESOURCE_TYPE.BOOLEAN,\n};\n\nconst decoded = decodeResource(buffer, resource);\n// decoded = { identifier: 5850, type: 1, value: true, tlvSize: 4 }\n```\n\n\n## decodeObjectInstance(buffer, objectInstance) ⇒ object\nDecodes object instance from TLV buffer.\n\n**Kind**: global function \n**Returns**: object - object - Decoded object instance. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| buffer | object | TLV buffer. |\n| objectInstance | object | Object which stores object instance identifier and resources. |\n\n**Example** \n```js\nconst buffer = Buffer.from([0x07, 0x00, 0xe4, 0x16, 0xb7, 0x44, 0x79, 0xff, 0x5c]);\nconst objectInstance: {\n identifier: 0,\n resources: [\n {\n identifier: 5815,\n type: TLV.RESOURCE_TYPE.FLOAT,\n },\n ]\n};\n\nconst decoded = decodeObjectInstance(buffer, objectInstance);\n// decoded = { identifier: 0, resources: [ { identifier: 5815, type: 3 } ] }\n```\n\n\n## decodeObject(buffer, object) ⇒ object\nDecodes LwM2M object to TLV buffer.\n\n**Kind**: global function \n**Returns**: object - object - Decoded object. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| buffer | object | TLV buffer. |\n| object | object | Object which stores object instances with their resources. |\n\n**Example** \n```js\nconst buffer = Buffer.from([0x07, 0x00, 0xe4, 0x16, 0xb7, 0x44, 0x79, 0xff, 0x5c]);\nconst object = {\n identifier: 3305,\n objectInstances: [{\n identifier: 0,\n resources: [\n {\n identifier: 5815,\n type: TLV.RESOURCE_TYPE.FLOAT,\n },\n ]\n }]\n};\n\nconst decoded = decodeObject(buffer, object);\n/*\ndecoded = {\n identifier: 3305,\n objectInstances: [\n {\n identifier: 0,\n resources: [\n {\n identifier: 5815,\n type: 3,\n value: 999.989990234375,\n tlvSize: 7\n }\n ]\n }\n ]\n}\n*/\n```\n","readmeFilename":"README.md"}