iotagent-node-lib 4.1.0 → 4.2.0

package/.readthedocs.yml

@@ -3,7 +3,11 @@ version: 2
 mkdocs:
   configuration: mkdocs.yml
 
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"
+
 python:
-  version: 3.8
   install:
     - requirements: doc/requirements.txt

package/CHANGES_NEXT_RELEASE

@@ -1 +0,0 @@
-

package/doc/api.md

@@ -955,6 +955,28 @@ The IOTA processes the entity attributes looking for a `TimeInstant` attribute.
 adds a `TimeInstant` attribute as metadata for every other attribute in the same request. With NGSI-LD, the Standard
 `observedAt` property-of-a-property is used instead.
 
+If a `TimeInstant` arrives as measure but not follows [ISO_8601](https://en.wikipedia.org/wiki/ISO_8601) then measure
+is refused.
+
+Depending on the `timestamp` configuration and if the measure contains a 
+value named `TimeInstant` with a correct value, the IoTA behaviour is described
+in the following table:
+
+`timestamp` value | measure contains `TimeInstant` | Behaviour 
+-- | -- | -- 
+true | Yes | TimeInstant and metadata updated with measure value 
+true | No | TimeInstant and metadata updated with server timestamp 
+false | Yes | TimeInstant and metadata updated with measure value 
+false | No | TimeInstant and metadata updated with server timestamp 
+Not defined | Yes | TimeInstant and metadata updated with measure value 
+Not defined | No | TimeInstant and metadata updated with server timestamp 
+
+The `timestamp` value used is:
+
+* The one defined at device level
+* The one defined at group level (if not defined at device level)
+* The one defined at [IoTA configuration level](admin.md#timestamp) / `IOTA_TIMESTAMP` env var (if not defined at group level or device level)
+
 ## Overriding global Context Broker host
 
 **cbHost**: Context Broker host URL. This option can be used to override the global CB configuration for specific types
@@ -963,8 +985,7 @@ of devices.
 ## Multitenancy, FIWARE Service and FIWARE ServicePath
 
 Every operation in the API require the `fiware-service` and `fiware-servicepath` to be defined; the operations are
-performed in the scope of those headers. For the list case, the special wildcard servicepath can be specified, `/*`. In
-this case, the operation applies to all the subservices of the service given by the `fiware-service` header.
+performed in the scope of those headers.
 
 ## Secured access to the Context Broker
 
@@ -1202,7 +1223,7 @@ Config group is represented by a JSON object with the following fields:
 | `subservice`                   |          | string         |            | Subservice of the devices of this type.                                                                                                                                                                                                                                   |
 | `resource`                     |          | string         |            | string representing the Southbound resource that will be used to assign a type to a device (e.g.: pathname in the southbound port).                                                                                                                                       |
 | `apikey`                       |          | string         |            | API Key string.                                                                                                                                                                                                                                                           |
-| `timestamp`                    | ✓        | bool           |            | Optional flag about whether or not to add the `TimeInstant` attribute to the device entity created, as well as a `TimeInstant` metadata to each attribute, with the current timestamp. With NGSI-LD, the Standard `observedAt` property-of-a-property is created instead. |
+| `timestamp`                    | ✓        | bool           |            | Optional flag about whether or not to add the `TimeInstant` attribute to the device entity created, as well as a `TimeInstant` metadata to each attribute, with the current server timestamp or provided `TimeInstant` as measure when follows ISO 8601 format (see [timestamp processing](#timestamp-processing) section for aditional detail). With NGSI-LD, the Standard `observedAt` property-of-a-property is created instead. |
 | `entity_type`                  |          | string         |            | name of the Entity `type` to assign to the group.                                                                                                                                                                                                                         |
 | `trust`                        | ✓        | string         |            | trust token to use for secured access to the Context Broker for this type of devices (optional; only needed for secured scenarios).                                                                                                                                       |
 | `cbHost`                       | ✓        | string         |            | Context Broker connection information. This options can be used to override the global ones for specific types of devices.                                                                                                                                                |
@@ -1226,9 +1247,8 @@ The following actions are available under the config group endpoint:
 
 #### Retrieve config groups `GET /iot/services`
 
-List all the config groups for the given `fiware-service` and `fiware-servicepath`. If the `fiware-servicepath` header
-has the wildcard expression, `/*`, all the config groups for that `fiware-service` are returned. The config groups that
-match the `fiware-servicepath` are returned in any other case.
+List all the config groups for the given `fiware-service` and `fiware-servicepath`. The config groups that match the
+`fiware-servicepath` are returned in any other case.
 
 _**Request headers**_
 
@@ -1427,7 +1447,7 @@ the API resource fields and the same fields in the database model.
 | `entity_name`         |          | `string`  |            | Name of the entity representing the device in the Context Broker                                                                                                                                                                                                 |
 | `entity_type`         |          | `string`  |            | Type of the entity in the Context Broker                                                                                                                                                                                                                         |
 | `timezone`            | ✓        | `string`  |            | Timezone of the device if that has any                                                                                                                                                                                                                           |
-| `timestamp`           | ✓        | `string`  |            | Flag about whether or not to add the `TimeInstant` attribute to the device entity created, as well as a `TimeInstant` metadata to each attribute, with the current timestamp. With NGSI-LD, the Standard `observedAt` property-of-a-property is created instead. |
+| `timestamp`           | ✓        | `string`  |            | Flag about whether or not to add the `TimeInstant` attribute to the device entity created, as well as a `TimeInstant` metadata to each attribute, with the current server timestamp or provided `TimeInstant` as measure when follows ISO 8601 format (see [timestamp processing](#timestamp-processing) section for aditional detail). With NGSI-LD, the Standard `observedAt` property-of-a-property is created instead. |
 | `apikey`              | ✓        | `string`  |            | Apikey key string to use instead of group apikey                                                                                                                                                                                                                 |
 | `endpoint`            | ✓        | `string`  |            | Endpoint where the device is going to receive commands, if any.                                                                                                                                                                                                  |
 | `protocol`            | ✓        | `string`  |            | Pame of the device protocol, for its use with an IoT Manager                                                                                                                                                                                                     |

package/doc/requirements.txt

@@ -1,4 +1,4 @@
-mkdocs==1.2.3
+mkdocs==1.2.4
 Pygments==2.15.0
 Markdown==3.3.4
-jinja2==3.0.0
+jinja2==3.1.3

package/lib/constants.js

@@ -61,6 +61,7 @@ module.exports = {
     NGSI_LD_TENANT_HEADER: 'NGSILD-Tenant',
     NGSI_LD_PATH_HEADER: 'NGSILD-Path',
     NGSI_LD_NULL: 'urn:ngsi-ld:null',
+    MEASURE: 'measure_',
     //FIXME: check Keystone support this in lowercase, then change
     AUTH_HEADER: 'X-Auth-Token',
     X_FORWARDED_FOR_HEADER: 'x-forwarded-for',
@@ -83,7 +84,7 @@ module.exports = {
     MONGO_ALARM: 'MONGO-ALARM',
     ORION_ALARM: 'ORION-ALARM',
     IOTAM_ALARM: 'IOTAM-ALARM',
-    
+
     ATTRIBUTE_DEFAULT,
     DATETIME_DEFAULT,
 

package/lib/services/ngsi/entities-NGSI-v2.js

@@ -282,6 +282,12 @@ function sendUpdateValueNgsi2(entityName, measures, typeInformation, token, call
         callback(new errors.TypeNotFound(null, entityName));
         return;
     }
+    //Rename all measures with matches with id and type to measure_id and measure_type
+    for (let measure of measures) {
+        if (measure.name === 'id' || measure.name === 'type') {
+            measure.name = constants.MEASURE + measure.name;
+        }
+    }
 
     //Make a copy of measures in an plain object: plainMeasures
     plainMeasures = reduceAttrToPlainObject(measures);
@@ -541,7 +547,6 @@ function sendUpdateValueNgsi2(entityName, measures, typeInformation, token, call
             //extract attributes
             let isEmpty = true;
             for (let attr of entities[ename][etype]) {
-                //Handling id/type measures, skip, hit & explicit (condition)
                 if (
                     attr.name !== 'id' &&
                     attr.name !== 'type' &&

package/package.json

@@ -2,7 +2,7 @@
   "name": "iotagent-node-lib",
   "license": "AGPL-3.0-only",
   "description": "IoT Agent library to interface with NGSI Context Broker",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "homepage": "https://github.com/telefonicaid/iotagent-node-lib",
   "keywords": [
     "fiware",

package/test/unit/ngsiv2/ngsiService/active-devices-test.js

@@ -932,6 +932,14 @@ describe('NGSI-v2 - Active attributes test', function () {
                     meas: {
                         value: 'measIoTA',
                         type: 'String'
+                    },
+                    measure_id: {
+                        type: 'text',
+                        value: 'idIoTA'
+                    },
+                    measure_type: {
+                        type: 'text',
+                        value: 'typeIoTA'
                     }
                 })
                 .reply(204);
@@ -1026,6 +1034,14 @@ describe('NGSI-v2 - Active attributes test', function () {
                     meas: {
                         value: 'measIoTA',
                         type: 'String'
+                    },
+                    measure_id: {
+                        value: 'idIoTA',
+                        type: 'text'
+                    },
+                    measure_type: {
+                        value: 'typeIoTA',
+                        type: 'text'
                     }
                 })
                 .reply(204);