Allows to define custom mappings for devices and assets for a tenant group only

doc/1/classes/assets-custom-properties/constructor/index.md

@@ -0,0 +1,18 @@
+---
+code: false
+type: page
+title: Constructor
+description: AssetsCustomProperties class constructor
+---
+
+# AssetsCustomProperties
+
+This class is used within the plugin in order to register custom properties definitions to the `assets` collection.
+They are automatically loaded at application startup.
+---
+
+## Constructor
+
+```ts
+AssetsCustomProperties()
+```

doc/1/classes/assets-custom-properties/index.md

@@ -0,0 +1,6 @@
+---
+code: true
+type: branch
+title: AssetsCustomProperties
+description: Kuzzle IoT Platform - AssetsCustomProperties class
+---

doc/1/classes/assets-custom-properties/register-metadata/index.md

@@ -0,0 +1,44 @@
+---
+code: true
+type: page
+title: registerMetadata
+description: Add properties definition to the 'metadata' field
+---
+
+# registerMetadata
+
+Add properties definition to the `metadata` field of the `assets` collection.
+
+
+```ts
+registerMetadata (mapping: JSONObject, options: JSONObject);
+```
+
+<br/>
+
+| Arguments | Type                  | Description                                 |
+|-----------|-----------------------|---------------------------------------------|
+| `mapping` | <pre>JSONObject</pre> | Mapping definiton of the `metadata` property |
+| `options` | <pre>JSONObject</pre> | Additional options |
+
+### options
+
+| Properties | Type                  | Description                                 |
+|-----------|-----------------------|---------------------------------------------|
+| `tenantGroup` | <pre>string</pre> | Name of the group for which the mapping should apply. If unspecified, mappings will apply to every group who does not have specific definition. |
+
+## Usage
+
+```ts
+import { DeviceManagerPlugin } from 'kuzzle-plugin-device-manager';
+
+const deviceManagerPlugin = new DeviceManagerPlugin();
+
+deviceManagerPlugin.assets.registerMetadata({
+    serial: {
+    type: 'keyword',
+    fields: {
+      text: { type: 'text' } }
+  }
+}, { tenantGroup: 'water_management' });
+```

doc/1/classes/devices-custom-properties/constructor/index.md

@@ -0,0 +1,18 @@
+---
+code: false
+type: page
+title: Constructor
+description: DevicesCustomProperties class constructor
+---
+
+# DevicesCustomProperties
+
+This class is used within the plugin in order to register custom properties definitions to the `devices` collection.
+They are automatically loaded at application startup.
+---
+
+## Constructor
+
+```ts
+DeviceCustomProperties()
+```

doc/1/classes/devices-custom-properties/index.md

@@ -0,0 +1,6 @@
+---
+code: true
+type: branch
+title: DevicesCustomProperties
+description: Kuzzle IoT Platform - DevicesCustomProperties class
+---

doc/1/classes/devices-custom-properties/register-measure/index.md

@@ -0,0 +1,62 @@
+---
+code: true
+type: page
+title: registerMeasure
+description: Add properties definition to the 'measures' field
+---
+
+# registerMeasure
+
+Add properties definition to the `measures` field of the `devices` collection.
+
+
+```ts
+registerMeasure (measureName: string, mapping: JSONObject, options: JSONObject);
+```
+
+<br/>
+
+| Arguments | Type                  | Description                                 |
+|-----------|-----------------------|---------------------------------------------|
+| `measureName` | <pre>string</pre> | Name of the measure you are willing to add to the `measures` field |
+| `mapping` | <pre>JSONObject</pre> | Mapping definiton of the custom measure property |
+| `options` | <pre>JSONObject</pre> | Additional options |
+
+### options
+
+| Properties | Type                  | Description                                 |
+|-----------|-----------------------|---------------------------------------------|
+| `tenantGroup` | <pre>string</pre> | Name of the group for which the mapping should apply. If unspecified, mappings will apply to every group who does not have specific definition |
+
+## Usage
+
+```ts
+import { DeviceManagerPlugin } from 'kuzzle-plugin-device-manager';
+
+const deviceManagerPlugin = new DeviceManagerPlugin();
+
+deviceManagerPlugin.devices.registerMeasure(
+  'temperature',
+  {
+    dynamic: 'false',
+    properties: {
+      fahrenheit: { type: 'float' },
+      celsius: { type: 'float' }
+    }
+  },
+  { tenantGroup: 'water_management' });
+
+deviceManagerPlugin.devices.registerMeasure(
+  'humidity',
+  {
+    dynamic: 'false',
+    properties: {
+      percentage: {
+        type: 'keyword',
+        fields: {
+          text: { type: 'text' } }
+      }
+    }
+  },
+  { tenantGroup: 'air_quality' });
+```

doc/1/classes/devices-custom-properties/register-metadata/index.md

@@ -0,0 +1,44 @@
+---
+code: true
+type: page
+title: registerMetadata
+description: Add properties definition to the 'metadata' field
+---
+
+# registerMetadata
+
+Add properties definition to the `metadata` field of the `devices` collection.
+
+
+```ts
+registerMetadata (mapping: JSONObject, options: JSONObject);
+```
+
+<br/>
+
+| Arguments | Type                  | Description                                 |
+|-----------|-----------------------|---------------------------------------------|
+| `mapping` | <pre>JSONObject</pre> | Mapping definiton of the `metadata` property |
+| `options` | <pre>JSONObject</pre> | Additional options |
+
+### options
+
+| Properties | Type                  | Description                                 |
+|-----------|-----------------------|---------------------------------------------|
+| `tenantGroup` | <pre>string</pre> | Name of the group for which the mapping should apply. If unspecified, mappings will apply to every group who does not have specific definition. |
+
+## Usage
+
+```ts
+import { DeviceManagerPlugin } from 'kuzzle-plugin-device-manager';
+
+const deviceManagerPlugin = new DeviceManagerPlugin();
+
+deviceManagerPlugin.devices.registerMetadata({
+    serial: {
+    type: 'keyword',
+    fields: {
+      text: { type: 'text' } }
+  }
+}, { tenantGroup: 'water_management' });
+```

doc/1/classes/devices-custom-properties/register-qos/index.md

@@ -0,0 +1,40 @@
+---
+code: true
+type: page
+title: registerQos
+description: Add properties definition to the 'qos' field
+---
+
+# registerQos
+
+Add properties definition to the `qos` field of the `devices` collection.
+
+
+```ts
+registerQos (mapping: JSONObject, options: JSONObject);
+```
+
+<br/>
+
+| Arguments | Type                  | Description                                 |
+|-----------|-----------------------|---------------------------------------------|
+| `mapping` | <pre>JSONObject</pre> | Mapping definiton of the `qos` property |
+| `options` | <pre>JSONObject</pre> | Additional options |
+
+### options
+
+| Properties | Type                  | Description                                 |
+|-----------|-----------------------|---------------------------------------------|
+| `tenantGroup` | <pre>string</pre> | Name of the group for which the mapping should apply. If unspecified, mappings will apply to every group who does not have specific definition. |
+
+## Usage
+
+```ts
+import { DeviceManagerPlugin } from 'kuzzle-plugin-device-manager';
+
+const deviceManagerPlugin = new DeviceManagerPlugin();
+
+deviceManagerPlugin.devices.registerQos({
+  battery: { type: 'integer' }
+}, { tenantGroup: 'water_management' });
+```

doc/1/controllers/engine/create/index.md

@@ -17,7 +17,7 @@ Creates a new device manager engine on an index
 ### HTTP
 
 ```http
-URL: http://kuzzle:7512/_/device-manager/engine/:index
+URL: http://kuzzle:7512/_/device-manager/engine/:index/[?group]
 Method: POST
 ```
 
@@ -28,13 +28,14 @@ Method: POST
   "controller": "device-manager/engine",
   "action": "create",
   "index": "tenant-ayse"
+  "group": "tenant-group" //  Optional. Specify the tenant group to apply custom mappings.
 }
 ```
 
 ### Kourou
 
 ```bash
-kourou device-manager/engine:create <index>
+kourou device-manager/engine:create <index> [group]
 ```
 ---