IoT Devices & Assets Management providing digital twins, payload decoding, normalized measures, provisioning. Multi-Tenant ready for white labelled and B2B2C applications.
Home Page: https://docs.kuzzle.io/official-plugins/device-manager/1
License: Apache License 2.0
This plugin provides the necessary APIs to manage a fleet of devices linked to assets.
It allows to decode the payloads received for the different device models of the application.
It works in a multi-tenant mode where each tenant has its own devices and assets.
See the documentation
In proper way to use this library in your program as an NPM module:
npm install kuzzle-device-manager
Add a mechanism to allows a whitelist of devices to send payloads to the plugin.
Add linkAsset and unlink with tests
It is no longer supported to manually create a device via the API endpoint (which is no longer available).
When extending the config of the plugin, the merging of the 2 configs is not a deep merge.
Here we should do a deep merge
We should have a mechanism that allows to replay a full range of payloads.
This mechanism should update the date of each payloads in a configurable way
We should have an action that list available decoders.
EmbeddedSDK.as methodQuestion every usage of an index name.
Custom mappings for assets and sensors are general so they will be loaded in every tenant collections.
If I have 2 kinds of tenants: air-quality and water-management, they will have different metadata for sensors and assets since it's two different kind of use case.
With the current implementation, every tenant kind will share the mappings of the two use cases.
We need a way to register custom mappings only for a particular tenant kind. And if no kind is specified then the mappings is applied to every tenant kind.
Possible API:
// only for "water-management" tenants
deviceManager.registerAssetsMappings(pipesMappings, 'water-management');
deviceManager.registerAssetsMappings(valvesMappings, 'water-management');
// only for "air-quality" tenants
deviceManager.registerAssetsMappings(classroomsMappings, 'air-quality');
// for all tenants
deviceManager.registerAssetsMappings(reportsMappings);
UX - frontend
Use the (new?) data validation module to validate plugin's documents.
Build and save a configuration catalog to send downlink to sensors
Ideally we could develop an API adapter to one of the platform (e.g. SPOT) to automatize the sent of downlinks with workflows:
Decoders are initialized at the root level of the plugin (inside the init fonction) it will be better to move all that logic of init at the place where it belong -> DecodersService
DecoderService / DecoderController (#114)
Add an accessor to the PluginContext in the Decoder base class
The payloads collection contains raw payloads from the sensors for debugging and analyze purposes.
We should add API action to remove old payloads (e.g. every payloads older 2 weeks)
We need bulk API actions to act on several sensors at the same time:
Those actions should have two different format:
In the engine config document, the autoProvisionning field name is misleading and incorrectly spelled.
n"autoProvisioning": true leads to thinking that the catalog documents are taken into account, whereas they are not. We should name it something like provisioningStrategy accepting auto or catalog, which would make its behavior more explicit.It would be handy to have all the device information within a measure in a separated property called origin
Add an accessor to the PluginContext in the Decoder base class
Allows to import assets with a CSV string.
Asset historization is a workflow and should not be part of the device manager plugin
Step to reproduce the issue
{
"controller": "device-manager/device",
"action": "attachTenant",
"body": {},
"index": "customer-toto",
"_id": "IamNotExisting
}
We need a validation mechanism for this action (and the device:link too) preventing the same Device to be linked to many Assets
Also allows to not return a HTTP error code when payload is not valid
Return a Partial error (~20x) when a payload was badly formatted or not successfully ingested.
Multidevice management by type of measure in assets
Actually the assets measure property is an object so it can contains only one device measure at a time
It's possible to define specific mappings for assets metadata.
We may have metadata with the same name but with different types and because ES mappings specificity it can lead to errors.
We should isolate each asset type metadata in a sub-property:
{
...
metadata: {
'caisse-mobile': {
// caisse mobile metadata
},
'platform': {
// platform metadata
}
}
}
Device provisioning with CSV
Add sensor attachTenant and detach with test
Forbid the association of a device to an asset if the asset is already linked to a device of the same measure type
Documentation should be deployed automatically
Add cypress tests for existing features:
We should add the packaged plugin (npm pack) in the release artifact to distribute it easily to our clients.
Standardize the action names of the device controller:
linkAsset and unlink -> linkAsset and unlinkAsset
attachTenant and detach -> attachTenant and detachTenant
When registering a decoder, an API action is generated and then we can receive payloads on this action.
We should create a role allowed to push payloads only on this API action so then we can also generate an user with corresponding API keys.
We could even generate the corresponding user.
We should also generate a global role (and associated user maybe) which is allowed to send payload on every action of the device-manager/payload controller.
Using mCreate in the batch processor in non-strict mode doesn't allow to throw explicit error messages. We should find a way to show errors coming from the errors array of this method.
We need an API action to easily clean the payloads collection of the device-manager engine.
This action should allow to easily remove payloads since X days and allow an ES query to filter on sensorModel andvalid for example
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.