iotagent-node-lib 2.19.0 → 2.22.0

package/doc/usermanual.md

@@ -209,8 +209,8 @@ function setCommandResult(entityName, resource, apikey, commandName, commandResu
 ###### Description
 
 Update the result of a command in the Context Broker. The result of the command has two components: the result of the
-command itself will be represented with the suffix `_result` in the entity while the status is updated in the attribute
-with the `_info` suffix.
+command itself will be represented with the suffix `_info` in the entity while the status is updated in the attribute
+with the `_status` suffix.
 
 ###### Params
 
@@ -258,7 +258,7 @@ function setDataUpdateHandler(newHandler)
 ###### Description
 
 Sets the new user handler for Entity update requests. This handler will be called whenever an update request arrives
-with the following parameters: (id, type, service, subservice, attributes, callback). The handler is in charge of
+with the following parameters: (`id`, `type`, `service`, `subservice`, `attributes`, `callback`). The handler is in charge of
 updating the corresponding values in the devices with the appropriate protocol.
 
 Once all the updates have taken place, the callback must be invoked with the updated Context Element. E.g.:
@@ -296,7 +296,7 @@ function setDataQueryHandler(newHandler)
 ###### Description
 
 Sets the new user handler for Entity query requests. This handler will be called whenever a query request arrives, with
-the following parameters: (id, type, service, subservice, attributes, callback). The handler must retrieve all the
+the following parameters: (`id`, `type`, `service`, `subservice`, `attributes`, `callback`). The handler must retrieve all the
 corresponding information from the devices and return a NGSI entity with the requested values.
 
 The callback must be invoked with the updated Context Element, using the information retrieved from the devices. E.g.:

package/docker/Mosquitto/Dockerfile

@@ -1,19 +1,35 @@
-FROM centos:7.9.2009
+ARG  IMAGE_TAG=11.3-slim
+FROM debian:${IMAGE_TAG}
 
-COPY aclfile /root/
-COPY startMosquitto.sh /bin
+ARG CLEAN_DEV_TOOLS
+ENV CLEAN_DEV_TOOLS ${CLEAN_DEV_TOOLS:-1}
 
 ENV CONGIF_FROM_ENV true
 
-RUN yum update -y && yum install -y wget \
-  && yum install -y epel-release \
-  && yum update -y epel-release \
-  && yum install -y mosquitto \
-  && cp /etc/mosquitto/mosquitto.conf /etc/mosquitto/mosquitto.conf.orig \
-  && chmod 755 /bin/startMosquitto.sh \
-  && mkdir /var/log/mosquitto \
-  && chown mosquitto:mosquitto /var/log/mosquitto \
-  && yum clean all
+COPY aclfile /root/
+COPY startMosquitto.sh /bin
+
+RUN \
+    # Install security updates
+    apt-get -y update && \
+    apt-get -y upgrade && \
+    # Install dependencies
+    apt-get -y install \
+       wget \
+       mosquitto && \
+    cp /etc/mosquitto/mosquitto.conf /etc/mosquitto/mosquitto.conf.orig && \
+    chmod 755 /bin/startMosquitto.sh && \
+    mkdir -p /var/log/mosquitto && \
+    chown mosquitto:mosquitto /var/log/mosquitto && \
+    mkdir -p /var/run/mosquitto/ && \
+    chown mosquitto:mosquitto /var/run/mosquitto && \
+    echo "INFO: Cleaning unused software..." && \
+    apt-get clean && \
+    apt-get -y autoremove --purge && \
+    if [ ${CLEAN_DEV_TOOLS} -eq 0 ] ; then exit 0 ; fi && \
+    # remove the same packages we installed at the beginning to build Orch
+    apt-get -y autoremove --purge \
+        wget
 
 
 EXPOSE 1883

package/docker/Mosquitto/README.md

@@ -2,10 +2,11 @@ Thi directory containts the Dockerfile (and associated files) for a container of
 This container is provide as a help for users to test with MQTT, but it is just an auxiliary material in this repository.
 
 The following releases matches with eclipse-mosquitto version:
-- 1.6.0 uses mosquitto-1.6.10-1.el7.x86_64
-- 1.5.0 uses mosquitto-1.6.10-1.el7.x86_64
-- 1.4.0 uses mosquitto-1.6.10-1.el7.x86_64
-- 1.3.0 uses mosquitto-1.6.8-1.el7.x86_64
-- 1.2.0 uses mosquitto-1.6.7-1.el7.x86_64
-- 1.1.0 uses mosquitto-1.5.8-1.el7.x86_64
-- 1.0.0 uses mosquitto-1.4.8-1.el7.x86_64
+- 2.0.0 uses mosquitto-2.0.11 from Debian 11
+- 1.6.0 uses mosquitto-1.6.10-1.el7.x86_64 (from Centos7)
+- 1.5.0 uses mosquitto-1.6.10-1.el7.x86_64 (from Centos7)
+- 1.4.0 uses mosquitto-1.6.10-1.el7.x86_64 (from Centos7)
+- 1.3.0 uses mosquitto-1.6.8-1.el7.x86_64 (from Centos7)
+- 1.2.0 uses mosquitto-1.6.7-1.el7.x86_64 (from Centos7)
+- 1.1.0 uses mosquitto-1.5.8-1.el7.x86_64 (from Centos7)
+- 1.0.0 uses mosquitto-1.4.8-1.el7.x86_64 (from Centos7)

package/docker/Mosquitto/startMosquitto.sh

@@ -1,7 +1,10 @@
 #!/usr/bin/env bash
 
+echo "INFO: startMosquitto..."
+
 if [ "${CONGIF_FROM_ENV}" = true ] ; then
     cp /etc/mosquitto/mosquitto.conf.orig /etc/mosquitto/mosquitto.conf
+    sed -i 's/log_dest file \/var\/log\/mosquitto\/mosquitto.log/log_dest stderr/g' /etc/mosquitto/mosquitto.conf
     echo "log_timestamp true" >> /etc/mosquitto/mosquitto.conf
     echo "log_timestamp_format %Y-%m-%dT%H:%M:%S" >> /etc/mosquitto/mosquitto.conf
     echo 'listener 9001' >> /etc/mosquitto/mosquitto.conf
@@ -18,4 +21,9 @@ if [ "${CONGIF_FROM_ENV}" = true ] ; then
     fi
 fi
 
+echo "INFO: content /etc/mosquitto/mosquitto.conf: "
+cat /etc/mosquitto/mosquitto.conf
+
+echo "INFO: start: startMosquitto -c /etc/mosquitto/mosquitto.conf"
+
 /usr/sbin/mosquitto -c /etc/mosquitto/mosquitto.conf

package/lib/fiware-iotagent-lib.js

@@ -314,6 +314,7 @@ exports.listDevices = deviceService.listDevices;
 exports.getDevice = deviceService.getDevice;
 exports.getDeviceSilently = deviceService.getDeviceSilently;
 exports.getDeviceByName = deviceService.getDeviceByName;
+exports.getDeviceByNameAndType = deviceService.getDeviceByNameAndType;
 exports.getDevicesByAttribute = deviceService.getDevicesByAttribute;
 exports.mergeDeviceWithConfiguration = deviceService.mergeDeviceWithConfiguration;
 exports.retrieveDevice = deviceService.retrieveDevice;
@@ -355,8 +356,6 @@ exports.fillService = domainUtils.fillService;
 
 exports.middlewares = middlewares;
 
-exports.commandLine = require('./command/commandLine');
-
 exports.dataPlugins = {
     compressTimestamp: require('./plugins/compressTimestamp'),
     attributeAlias: require('./plugins/attributeAlias'),

package/lib/jexlTranformsMap.js

@@ -65,7 +65,9 @@ const map = {
         let s = new Set(arr);
         s.delete(x);
         return Array.from(s);
-    }
+    },
+    touppercase: (val) => String(val).toUpperCase(),
+    tolowercase: (val) => String(val).toLowerCase()
 };
 
 exports.map = map;

package/lib/model/Group.js

@@ -62,7 +62,8 @@ const Group = new Schema({
     expressionLanguage: String,
     explicitAttrs: ExplicitAttrsType,
     defaultEntityNameConjunction: String,
-    ngsiVersion: String
+    ngsiVersion: String,
+    entityNameExp: String
 });
 
 function load(db) {

package/lib/model/dbConn.js

@@ -113,6 +113,10 @@ function init(host, db, port, options, callback) {
             options,
             retries
         );
+        // FIXME: useNewUrlParser is no longer used in underlying mongodb driver 4.x
+        // (see https://github.com/mongodb/node-mongodb-native/blob/HEAD/etc/notes/CHANGES_4.0.0.md)
+        // but not sure if current mongoose version is still using mongodb 3.x internally
+        // probably mongodb-connectionoptions-test.js needs to be fixed if useNewUrlParser is removed at the end
         options.useNewUrlParser = true;
         mongoose.set('useCreateIndex', true);
         /* eslint-disable-next-line no-unused-vars */

package/lib/plugins/expressionPlugin.js

@@ -30,6 +30,8 @@ const jexlParser = require('./jexlParser');
 const config = require('../commonConfig');
 /* eslint-disable no-unused-vars */
 const logger = require('logops');
+const errors = require('../errors');
+const constants = require('../constants');
 const context = {
     op: 'IoTAgentNGSI.expressionPlugin'
 };
@@ -42,6 +44,22 @@ function setJEXLTransforms(transformationMap) {
     jexlParser.setTransforms(transformationMap);
 }
 
+function applyExpression(expression, context, typeInformation) {
+    let parser = jexlParser;
+    if (!checkJexl(typeInformation)) {
+        parser = legacyParser;
+    }
+    return parser.applyExpression(expression, context, typeInformation);
+}
+
+function extractContext(attributeList, typeInformation) {
+    let parser = jexlParser;
+    if (!checkJexl(typeInformation)) {
+        parser = legacyParser;
+    }
+    return parser.extractContext(attributeList);
+}
+
 function mergeAttributes(attrList1, attrList2) {
     const finalCollection = _.clone(attrList1);
     const additionalItems = [];
@@ -70,26 +88,26 @@ function mergeAttributes(attrList1, attrList2) {
     return finalCollection.concat(additionalItems);
 }
 
-function update(entity, typeInformation, callback) {
-    function checkJexl(typeInformation) {
-        if (
-            config.getConfig().defaultExpressionLanguage === 'jexl' &&
-            typeInformation.expressionLanguage &&
-            typeInformation.expressionLanguage !== 'legacy'
-        ) {
-            return true;
-        } else if (config.getConfig().defaultExpressionLanguage === 'jexl' && !typeInformation.expressionLanguage) {
-            return true;
-        } else if (
-            config.getConfig().defaultExpressionLanguage === 'legacy' &&
-            typeInformation.expressionLanguage &&
-            typeInformation.expressionLanguage === 'jexl'
-        ) {
-            return true;
-        }
-        return false;
+function checkJexl(typeInformation) {
+    if (
+        config.getConfig().defaultExpressionLanguage === 'jexl' &&
+        typeInformation.expressionLanguage &&
+        typeInformation.expressionLanguage !== 'legacy'
+    ) {
+        return true;
+    } else if (config.getConfig().defaultExpressionLanguage === 'jexl' && !typeInformation.expressionLanguage) {
+        return true;
+    } else if (
+        config.getConfig().defaultExpressionLanguage === 'legacy' &&
+        typeInformation.expressionLanguage &&
+        typeInformation.expressionLanguage === 'jexl'
+    ) {
+        return true;
     }
+    return false;
+}
 
+function update(entity, typeInformation, callback) {
     function processEntityUpdateNgsi2(attributes) {
         let parser = legacyParser;
         if (checkJexl(typeInformation)) {
@@ -114,15 +132,32 @@ function update(entity, typeInformation, callback) {
 
     try {
         logger.debug(context, 'expressionPlugin entity %j', entity);
-        let attsArray = utils.extractAttributesArrayFromNgsi2Entity(entity);
-        attsArray = processEntityUpdateNgsi2(attsArray);
-        entity = utils.createNgsi2Entity(entity.id, entity.type, attsArray, true);
+        const attsArray = utils.extractAttributesArrayFromNgsi2Entity(entity);
+        // Exclude processing all attr expressions when current attr is of type 'commandStatus' or 'commandResult'
+        const attsArrayFiltered = attsArray.filter((obj) => {
+            return ![constants.COMMAND_STATUS, constants.COMMAND_RESULT].includes(obj.type);
+        });
+        const attsArrayCmd = attsArray.filter((obj) => {
+            // just attr of type 'commandStatus' or 'commandResult'
+            return [constants.COMMAND_STATUS, constants.COMMAND_RESULT].includes(obj.type);
+        });
+        let attsArrayFinal = [];
+        if (attsArrayFiltered.length > 0) {
+            attsArrayFinal = processEntityUpdateNgsi2(attsArrayFiltered);
+        }
+        attsArrayFinal = attsArrayFinal.concat(attsArrayCmd);
+        entity = utils.createNgsi2Entity(entity.id, entity.type, attsArrayFinal, true);
 
         callback(null, entity, typeInformation);
     } catch (e) {
+        logger.info(context, 'expressionPlugin error %j procesing entity %j', e, entity);
         callback(e);
+        return;
     }
 }
 
 exports.update = update;
 exports.setJEXLTransforms = setJEXLTransforms;
+exports.applyExpression = applyExpression;
+exports.extractContext = extractContext;
+exports.checkJexl = checkJexl;

package/lib/plugins/multiEntity.js

@@ -30,7 +30,7 @@ const _ = require('underscore');
 const constants = require('../constants');
 const legacyParser = require('./expressionParser');
 const jexlParser = require('./jexlParser');
-const config = require('../commonConfig');
+const expressionPlugin = require('./expressionPlugin');
 /* eslint-disable-next-line  no-unused-vars */
 const logger = require('logops');
 /* eslint-disable-next-line  no-unused-vars */
@@ -41,27 +41,8 @@ const utils = require('./pluginUtils');
 /* eslint-disable-next-line  no-unused-vars */
 const aliasPlugin = require('./attributeAlias');
 
-function checkJexl(typeInformation) {
-    if (
-        config.getConfig().defaultExpressionLanguage === 'jexl' &&
-        typeInformation.expressionLanguage &&
-        typeInformation.expressionLanguage !== 'legacy'
-    ) {
-        return true;
-    } else if (config.getConfig().defaultExpressionLanguage === 'jexl' && !typeInformation.expressionLanguage) {
-        return true;
-    } else if (
-        config.getConfig().defaultExpressionLanguage === 'legacy' &&
-        typeInformation.expressionLanguage &&
-        typeInformation.expressionLanguage === 'jexl'
-    ) {
-        return true;
-    }
-    return false;
-}
-
-function hasEntityName(item) {
-    return item.entity_name;
+function hasEntityNameOrEntityType(item) {
+    return item.entity_name || item.entity_type;
 }
 
 /**
@@ -225,37 +206,50 @@ function propagateTimestamp(entity, entities) {
 }
 
 function updateAttribute(entity, typeInformation, callback) {
-    let parser = legacyParser;
-    if (checkJexl(typeInformation)) {
-        parser = jexlParser;
-    }
-    const attsArray = utils.extractAttributesArrayFromNgsi2Entity(entity);
-    const ctx = parser.extractContext(attsArray);
-
-    let entities = [entity];
-    if (typeInformation.active) {
-        const multiEntityAttributes = typeInformation.active.filter(hasEntityName);
-        for (let i in multiEntityAttributes) {
-            if (parser.contextAvailable(multiEntityAttributes[i].entity_name, ctx)) {
-                let entityName = parser.applyExpression(multiEntityAttributes[i].entity_name, ctx, typeInformation);
-                // An entity_name could not be null, but a result or expression could be null
-                if (entityName !== null) {
-                    multiEntityAttributes[i].entity_name = entityName;
+    try {
+        logger.debug(context, 'multiEntityPlugin entity %j', entity);
+        let parser = jexlParser;
+        if (!expressionPlugin.checkJexl(typeInformation)) {
+            parser = legacyParser;
+        }
+        // The context for the JEXL expression should be the ID, TYPE, S, SS
+        let attrList = utils.getIdTypeServSubServiceFromDevice(typeInformation);
+        const attsArray = utils.extractAttributesArrayFromNgsi2Entity(entity);
+        attrList = attrList.concat(attsArray);
+        const ctx = parser.extractContext(attrList);
+        let entities = [entity];
+        if (typeInformation.active) {
+            const multiEntityAttributes = typeInformation.active.filter(hasEntityNameOrEntityType);
+            for (let i in multiEntityAttributes) {
+                if (!multiEntityAttributes[i].entity_name) {
+                    // Then hasEntityType and entity_name should be device.name
+                    multiEntityAttributes[i].entity_name = typeInformation.name;
+                }
+                if (parser.contextAvailable(multiEntityAttributes[i].entity_name, ctx)) {
+                    let entityName = parser.applyExpression(multiEntityAttributes[i].entity_name, ctx, typeInformation);
+                    // An entity_name could not be null, but a result or expression could be null
+                    if (entityName !== null) {
+                        multiEntityAttributes[i].entity_name = entityName;
+                    }
                 }
             }
+            const newEntities = extractNewEntities(multiEntityAttributes, typeInformation.type);
+
+            if (multiEntityAttributes.length > 0) {
+                let resultAttributes = filterOutMultientitiesNgsi2(entity, multiEntityAttributes);
+                const newCes = generateNewCEsNgsi2(entity, newEntities, multiEntityAttributes);
+                entities = [resultAttributes].concat(newCes);
+                propagateTimestamp(entity, entities);
+            } else {
+                entities = entity;
+            }
         }
-        const newEntities = extractNewEntities(multiEntityAttributes, typeInformation.type);
-
-        if (multiEntityAttributes.length > 0) {
-            let resultAttributes = filterOutMultientitiesNgsi2(entity, multiEntityAttributes);
-            const newCes = generateNewCEsNgsi2(entity, newEntities, multiEntityAttributes);
-            entities = [resultAttributes].concat(newCes);
-            propagateTimestamp(entity, entities);
-        } else {
-            entities = entity;
-        }
+        callback(null, entities, typeInformation);
+    } catch (e) {
+        logger.info(context, 'multiEntityPlugin error %j procesing entity %j', e, entity);
+        callback(e);
+        return;
     }
-    callback(null, entities, typeInformation);
 }
 
 exports.update = updateAttribute;

package/lib/plugins/pluginUtils.js

@@ -167,9 +167,25 @@ function identityFilter(entity, typeInformation, callback) {
     callback(null, entity, typeInformation);
 }
 
+/**
+ * Creates an array of attributes from an device including id, type, service and subservice
+ * @param       {Object}             device
+ * @return      {Object}             Array of id, type, service and subservice extracted from device
+ */
+function getIdTypeServSubServiceFromDevice(typeInformation) {
+    let attrList = [
+        { name: 'id', type: 'String', value: typeInformation.id },
+        { name: 'type', type: 'String', value: typeInformation.type },
+        { name: 'service', type: 'String', value: typeInformation.service },
+        { name: 'subservice', type: 'String', value: typeInformation.subservice }
+    ];
+    return attrList;
+}
+
 exports.createProcessAttribute = createProcessAttribute;
 exports.createUpdateFilter = createUpdateFilter;
 exports.createQueryFilter = createQueryFilter;
 exports.identityFilter = identityFilter;
 exports.createNgsi2Entity = createNgsi2Entity;
 exports.extractAttributesArrayFromNgsi2Entity = extractAttributesArrayFromNgsi2Entity;
+exports.getIdTypeServSubServiceFromDevice = getIdTypeServSubServiceFromDevice;

package/lib/services/commands/commandService.js

@@ -29,10 +29,12 @@ const config = require('../../commonConfig');
 const constants = require('../../constants');
 const ngsiService = require('../ngsi/ngsiService');
 const deviceService = require('../devices/deviceService');
+const pluginUtils = require('../../plugins/pluginUtils');
 let daemonId;
 const context = {
     op: 'IoTAgentNGSI.CommandService'
 };
+const expressionPlugin = require('../../plugins/expressionPlugin');
 
 function listCommands(service, subservice, deviceId, callback) {
     logger.debug(context, 'Listing all commands for device [%s]', deviceId);
@@ -41,11 +43,35 @@ function listCommands(service, subservice, deviceId, callback) {
 }
 
 function addCommand(service, subservice, deviceId, command, callback) {
-    logger.debug(context, 'Adding command [%s] to the queue for device [%s]', command.name, deviceId);
-
+    logger.debug(context, 'Adding command [%j] to the queue for device [%s]', command, deviceId);
     config.getCommandRegistry().add(service, subservice, deviceId, command, callback);
 }
 
+function addCommandDevice(service, subservice, device, command, callback) {
+    logger.debug(context, 'Adding command [%j] to the queue for device [%j]', command, device);
+    let deviceCmd;
+    if (device && device.commands) {
+        deviceCmd = device.commands.find((c) => c.name === command.name);
+    }
+    if (deviceCmd && deviceCmd.expression) {
+        let parser = expressionPlugin;
+        // The context for the JEXL expression should be the ID, TYPE, S, SS
+        let attrList = pluginUtils.getIdTypeServSubServiceFromDevice(device);
+        attrList = device.staticAttributes ? attrList.concat(device.staticAttributes) : attrList.concat([]);
+        let ctxt = parser.extractContext(attrList, device);
+        logger.debug(context, 'attrList [%j] for device %j', attrList, device);
+        // expression result will be the full command payload
+        let cmdValueRes = null;
+        try {
+            cmdValueRes = parser.applyExpression(deviceCmd.expression, ctxt, device);
+        } catch (e) {
+            // nothing to do
+        }
+        command.value = cmdValueRes ? cmdValueRes : deviceCmd.expression;
+    }
+    config.getCommandRegistry().add(service, subservice, device.id, command, callback);
+}
+
 function updateCommand(service, subservice, deviceId, name, value, callback) {
     logger.debug(context, 'Updating command [%s] for device [%s] with value [%s]', name, deviceId, value);
 
@@ -147,6 +173,7 @@ function stopExpirationDaemon(callback) {
 
 exports.list = intoTrans(context, listCommands);
 exports.add = addCommand;
+exports.addCmd = addCommandDevice;
 exports.update = updateCommand;
 exports.remove = removeCommand;
 exports.start = startExpirationDaemon;

package/lib/services/common/domain.js

@@ -47,6 +47,8 @@ function cleanDomain(domainToClean) {
     delete domainToClean.from;
     delete domainToClean.op;
     delete domainToClean.path;
+    delete domainToClean.service;
+    delete domainToClean.subservice;
     domainToClean.exit();
 }
 
@@ -139,8 +141,10 @@ function ensureSouthboundTransaction(context, callback) {
         reqDomain.corr = reqDomain.trans;
     }
 
-    if (context && context.op) {
-        reqDomain.op = context.op;
+    if (context) {
+        if (context.op) {
+            reqDomain.op = context.op;
+        }
 
         if (context.srv) {
             reqDomain.service = context.srv;

package/lib/services/common/iotManagerService.js

@@ -60,7 +60,8 @@ function register(callback) {
             explicitAttrs: service.explicitAttrs,
             expressionLanguage: service.expressionLanguage,
             defaultEntityNameConjunction: service.defaultEntityNameConjunction,
-            ngsiVersion: service.ngsiVersion
+            ngsiVersion: service.ngsiVersion,
+            entityNameExp: service.entityNameExp
         };
     }
 

package/lib/services/devices/deviceRegistryMemory.js

@@ -149,13 +149,19 @@ function getDevice(id, service, subservice, callback) {
     }
 }
 
-function getByName(name, service, subservice, callback) {
+function getByNameAndType(name, type, service, subservice, callback) {
     const devices = _.values(registeredDevices[service]);
     let device;
 
     for (let i = 0; i < devices.length; i++) {
         if (devices[i].name === name) {
-            device = devices[i];
+            if (type) {
+                if (devices[i].type === type) {
+                    device = devices[i];
+                }
+            } else {
+                device = devices[i];
+            }
         }
     }
 
@@ -166,6 +172,10 @@ function getByName(name, service, subservice, callback) {
     }
 }
 
+function getByName(name, service, subservice, callback) {
+    getByNameAndType(name, null, service, subservice, callback);
+}
+
 function update(device, callback) {
     registeredDevices[device.service][device.id] = deepClone(device);
     callback(null, device);
@@ -208,4 +218,5 @@ exports.list = listDevices;
 exports.get = getDevice;
 exports.getSilently = getDevice;
 exports.getByName = getByName;
+exports.getByNameAndType = getByNameAndType;
 exports.clear = clear;

package/lib/services/devices/deviceRegistryMongoDB.js

@@ -243,15 +243,18 @@ function getDevice(id, service, subservice, callback) {
     });
 }
 
-function getByName(name, service, servicepath, callback) {
+function getByNameAndType(name, type, service, servicepath, callback) {
     context = fillService(context, { service, subservice: servicepath });
-    logger.debug(context, 'Looking for device with name [%s].', name);
-
-    const query = Device.model.findOne({
-        name,
-        service,
+    let optionsQuery = {
+        name: name,
+        service: service,
         subservice: servicepath
-    });
+    };
+    if (type) {
+        optionsQuery.type = type;
+    }
+    logger.debug(context, 'Looking for device with [%j].', optionsQuery);
+    const query = Device.model.findOne(optionsQuery);
 
     query.select({ __v: 0 });
 
@@ -270,6 +273,10 @@ function getByName(name, service, servicepath, callback) {
     });
 }
 
+function getByName(name, service, servicepath, callback) {
+    getByNameAndType(name, null, service, servicepath, callback);
+}
+
 /**
  * Updates the given device into the database.
  * updated.
@@ -361,4 +368,5 @@ exports.list = alarmsInt(constants.MONGO_ALARM, listDevices);
 exports.get = alarmsInt(constants.MONGO_ALARM, getDevice);
 exports.getSilently = getDevice;
 exports.getByName = alarmsInt(constants.MONGO_ALARM, getByName);
+exports.getByNameAndType = alarmsInt(constants.MONGO_ALARM, getByNameAndType);
 exports.clear = alarmsInt(constants.MONGO_ALARM, clear);