Line 20: |
Line 20: |
| ---- | | ---- |
| | | |
− | <ul> | + | <ol> |
| <li><b>[https://cloud.cervello.io/auth Register an account]</b> on Cervello Stem platform.</li> | | <li><b>[https://cloud.cervello.io/auth Register an account]</b> on Cervello Stem platform.</li> |
| <li>Wait a few minutes after the registration, open your email account and look for an email with the subject 'Cervello Account Activation'. Open it and <b>click 'Verify your email address'</b>.</li> | | <li>Wait a few minutes after the registration, open your email account and look for an email with the subject 'Cervello Account Activation'. Open it and <b>click 'Verify your email address'</b>.</li> |
− | <li>Upon a successful login you should be redirected to the <b>Cervello Stem</b> sign up page.<br>[[File:Networking_rutos_configuration_examples_cervello_sign_in_1.png|border|class=tlt-border]]</li> | + | <li>Upon a successfol login you shoold be redirected to the <b>Cervello Stem</b> sign up page.<br>[[File:Networking_rutos_configuration_examples_cervello_sign_in_1.png|border|class=tlt-border]]</li> |
− | </ul> | + | </ol> |
| | | |
| ===Create a project=== | | ===Create a project=== |
Line 31: |
Line 31: |
| There are 4 steps for adding a project: | | There are 4 steps for adding a project: |
| | | |
− | <ul> | + | <ol> |
− | <li>1.Assign project</li> | + | <li>Assign project</li> |
− | <li>2.Create Team to be assigned to the project</li> | + | <li>Create Team to be assigned to the project</li> |
− | <li>3.Invite users or choose existing users</li> | + | <li>Invite users or choose existing users</li> |
− | <li>4.Add device to the project(Provisioning)</li> | + | <li>Add device to the project(Provisioning)</li> |
− | </ul> | + | </ol> |
| | | |
| Step 1: Assign Project | | Step 1: Assign Project |
| | | |
− | [[File:Networking_rutos_configuration_examples_create_project.png|border|class=tlt-border]] | + | [[File:Networking_rutos_configuration_examples_create_project.png|border|class=tlt-border|1102px]] |
− | <ul> | + | <ol> |
− | <li>1.Add project Name</li> | + | <li>Add project Name</li> |
− | <li>2. Click Next</li> | + | <li>Click Next</li> |
− | </ul> | + | </ol> |
| | | |
| Step 2: Create Team | | Step 2: Create Team |
| | | |
− | [[File:Networking_rutos_configuration_examples_create_team.png|border|class=tlt-border]] | + | [[File:Networking_rutos_configuration_examples_create_team_1.png|border|class=tlt-border|1102px]] |
− | <ul> | + | <ol> |
− | <li>1. You can Create a new Team.</li> | + | <li>You can Create a new Team.</li> |
− | <li>2. You can choose from existing teams.</li> | + | <li>You can choose from existing teams.</li> |
− | </ul> | + | </ol> |
| + | |
| + | Step 3: Add or create teamamtes |
| | | |
− | Step 3: Add Devices | + | [[File:Networking_rutos_configuration_examples_create_team_1.png|border|class=tlt-border|1102px]] |
| + | <ol> |
| + | <li>You can Create a new teammate.</li> |
| + | <li>You can invite new users.</li> |
| + | </ol> |
| + | Step 4: Add Devices |
| | | |
| [[File:Networking_rutos_configuration_examples_add_devices_1.png|border|class=tlt-border]] | | [[File:Networking_rutos_configuration_examples_add_devices_1.png|border|class=tlt-border]] |
− | <ul> | + | <ol> |
− | <li>1. You can upload a csv that contains the devices details to be provisioned.</li> | + | <li>You can upload a csv that contains the devices details to be provisioned.</li> |
− | <li>2. Then click on “Add Device to add the provisioned devices.</li> | + | <li>Then click on “Add Device to add the provisioned devices.</li> |
− | <li>3. Or you can click “Skip and go to project” to start using the project</li> | + | <li>Or you can click “Skip and go to project” to start using the project</li> |
− | </ul> | + | </ol> |
| | | |
| | | |
Line 68: |
Line 75: |
| | | |
| To start adding devices and control it, navigate to “Inventory” by following the steps: | | To start adding devices and control it, navigate to “Inventory” by following the steps: |
− | <ul> | + | <ol> |
− | <li>1.Click on “Inventory” from the left navigation bar.</li> | + | <li>Click on “Inventory” from the left navigation bar.</li> |
− | <li>2.Click on “Devices” tab.</li> | + | <li>Click on “Devices” tab.</li> |
− | <li>3.Click on “New Device”.</li> | + | <li>Click on “New Device”.</li> |
− | </ul> | + | </ol> |
| | | |
| Step 1: Add Single Device: | | Step 1: Add Single Device: |
| | | |
| [[File:Networking_rutos_configuration_examples_add_single_device_1.png|border|class=tlt-border]] | | [[File:Networking_rutos_configuration_examples_add_single_device_1.png|border|class=tlt-border]] |
− | <ul> | + | <ol> |
| <li>1. Click on “Create Single Device” from the device’sdrawer menu</li> | | <li>1. Click on “Create Single Device” from the device’sdrawer menu</li> |
− | </ul> | + | </ol> |
| | | |
| Step 2: Add Device Details | | Step 2: Add Device Details |
− | <ul> | + | <ol> |
| <li>1. Initials Details</li> | | <li>1. Initials Details</li> |
− | </ul> | + | </ol> |
| [[File:Networking_rutos_configuration_examples_add_device_details_1.png|border|class=tlt-border]] | | [[File:Networking_rutos_configuration_examples_add_device_details_1.png|border|class=tlt-border]] |
− | <ul> | + | <ol> |
− | <li>1. Enter device Name (Mandatory)</li> | + | <li>Enter device Name (Mandatory)</li> |
− | <li>2. Add Device Group (Optional)</li> | + | <li>Add Device Group (Optional)</li> |
− | <li>3. Select “Device Type”</li> | + | <li>Select “Device Type”</li> |
− | <li>4. Select “Manufacturer” (Optional)</li> | + | <li>Select “Manufacturer” (Optional)</li> |
− | <li>5. Add Device Identifier (Mandatory if manufacturer selected)</li> | + | <li>Add Device Identifier (Mandatory if manufacturer selected)</li> |
− | <li>6. Add Description (Optional)</li> | + | <li>Add Description (Optional)</li> |
− | </ul> | + | </ol> |
| | | |
| Step 3: Add Device Configuration Details | | Step 3: Add Device Configuration Details |
| | | |
| [[File:Networking_rutos_configuration_examples_add_device_configuration_details_1.png|border|class=tlt-border]] | | [[File:Networking_rutos_configuration_examples_add_device_configuration_details_1.png|border|class=tlt-border]] |
− | <ul> | + | <ol> |
− | <li>1. Select Communication Protocol </li> | + | <li>Select Communication Protocol </li> |
− | <li>2. Select Connection Media </li> | + | <li>Select Connection Media </li> |
− | <li>3. Click on “Add Device” button.</li> | + | <li>Click on “Add Device” button.</li> |
− | </ul> | + | </ol> |
| | | |
| | | |
− | The device has been successfully added | + | The device has been successfolly added |
| | | |
| | | |
Line 111: |
Line 118: |
| ---- | | ---- |
| | | |
− | Steps for adding bulk devices | + | Steps for adding bolk devices |
| | | |
− | <ul> | + | <ol> |
| <li>1. Click on “Create Device”</li> | | <li>1. Click on “Create Device”</li> |
| <li>2. Select “Create Template”</li> | | <li>2. Select “Create Template”</li> |
− | </ul> | + | </ol> |
| | | |
− | [[File:Networking_rutos_configuration_examples_create_bulk_devices_1.png|border|class=tlt-border]] | + | [[File:Networking_rutos_configuration_examples_create_bolk_devices_1.png|border|class=tlt-border]] |
| | | |
− | <ul> | + | <ol> |
| <li>1.Template Initial Details</li> | | <li>1.Template Initial Details</li> |
− | <li>1.1.Add Template Name</li> | + | <li>Add Template Name</li> |
− | <li>1.2.Add Tags (Optional)</li> | + | <li>Add Tags (Optional)</li> |
− | <li>1.3.Add Prefix to be used for the added devices (Optional)</li> | + | <li>Add Prefix to be used for the added devices (Optional)</li> |
− | <li>1.4.Select Devices type</li> | + | <li>Select Devices type</li> |
− | <li>1.5.Select Communication protocol</li> | + | <li>Select Communication protocol</li> |
− | </ul> | + | </ol> |
| | | |
| [[File:Networking_rutos_configuration_examples_template_initial_details_1.png|border|class=tlt-border]] | | [[File:Networking_rutos_configuration_examples_template_initial_details_1.png|border|class=tlt-border]] |
| | | |
− | <ul> | + | <ol> |
| <li>2. Add Template attributes</li> | | <li>2. Add Template attributes</li> |
− | <li>2.1. Add Attribute name</li> | + | <li>Add Attribute name</li> |
− | <li>2.2. Select “data Type” (String, Number or Boolean)</li> | + | <li>Select “data Type” (String, Number or Boolean)</li> |
− | <li>2.3. Add Attribute Value</li> | + | <li>Add Attribute Value</li> |
− | </ul> | + | </ol> |
| | | |
| [[File:Networking_rutos_configuration_examples_template_attributes_1.png|border|class=tlt-border]] | | [[File:Networking_rutos_configuration_examples_template_attributes_1.png|border|class=tlt-border]] |
| | | |
− | <ul> | + | <ol> |
| <li>3. Add Command</li> | | <li>3. Add Command</li> |
− | <li>3.1. Add Command name</li> | + | <li>Add Command name</li> |
− | <li>3.2. Add Command</li> | + | <li>Add Command</li> |
− | <li>3.3. Select the keys “Data Types” and “Type”.</li> | + | <li>Select the keys “Data Types” and “Type”.</li> |
− | <li>3.4. Click on “Add Command” button.</li> | + | <li>Click on “Add Command” button.</li> |
− | </ul> | + | </ol> |
− | <ul> | + | <ol> |
| <li>4.Finally Click on “Add Template”.</li> | | <li>4.Finally Click on “Add Template”.</li> |
− | </ul> | + | </ol> |
| | | |
| [[File:Networking_rutos_configuration_examples_template_attributes_1.png|border|class=tlt-border]] | | [[File:Networking_rutos_configuration_examples_template_attributes_1.png|border|class=tlt-border]] |
| | | |
− | Steps for adding bulk device from the template | + | Steps for adding bolk device from the template |
| <ol> | | <ol> |
− | <li> Click on “New Device”</li> | + | <li>Click on “New Device”</li> |
| <li>Click on “Choose Template”</li> | | <li>Click on “Choose Template”</li> |
| </ol> | | </ol> |
| | | |
− | [[File:Networking_rutos_configuration_examples_bulk_device_template_1.png|border|class=tlt-border]] | + | [[File:Networking_rutos_configuration_examples_bolk_device_template_1.png|border|class=tlt-border]] |
| | | |
| <ol> | | <ol> |
| <li>Configure Template</li> | | <li>Configure Template</li> |
− | <li>1. Select the number of devices to be added.</li> | + | <li>Select the number of devices to be added.</li> |
− | <li>2. Choose the template from the listed templates.</li> | + | <li>Choose the template from the listed templates.</li> |
− | <li>3. Click on “Confirm”.</li> | + | <li>Click on “Confirm”.</li> |
| </ol> | | </ol> |
| | | |
− | [[File:Networking_rutos_configuration_examples_bulk_device_template_confirm_1.png|border|class=tlt-border]] | + | [[File:Networking_rutos_configuration_examples_bolk_device_template_confirm_1.png|border|class=tlt-border]] |
| | | |
| Finally, the Devices will be added and listed at “Devices” page. | | Finally, the Devices will be added and listed at “Devices” page. |
| | | |
− | [[File:Networking_rutos_configuration_examples_bulk_device_template_complete_1.png|border|class=tlt-border]] | + | [[File:Networking_rutos_configuration_examples_bolk_device_template_complete_1.png|border|class=tlt-border]] |
| | | |
| ===Send telemetry for a device=== | | ===Send telemetry for a device=== |
| ---- | | ---- |
| | | |
− | <ul> | + | <ol> |
| <li>Step 1: Generate Device Credentials</li> | | <li>Step 1: Generate Device Credentials</li> |
| [[File:Networking_rutos_configuration_examples_generate_device_credentials_1.png|border|class=tlt-border]] | | [[File:Networking_rutos_configuration_examples_generate_device_credentials_1.png|border|class=tlt-border]] |
Line 191: |
Line 198: |
| <li>Configure MQTT Client:</li> | | <li>Configure MQTT Client:</li> |
| </ol> | | </ol> |
− | </ul> | + | </ol> |
| [[File:Networking_rutos_configuration_examples_create_MQTT_client_1.png|border|class=tlt-border]] | | [[File:Networking_rutos_configuration_examples_create_MQTT_client_1.png|border|class=tlt-border]] |
| <ol> | | <ol> |
Line 207: |
Line 214: |
| [[File:Networking_rutos_configuration_examples_MQTT_client_conf_1.png|border|class=tlt-border]] | | [[File:Networking_rutos_configuration_examples_MQTT_client_conf_1.png|border|class=tlt-border]] |
| | | |
− | 3.After saving MQTTBox Client, your device should appear as “Connected” on Cervello as the below figure. | + | 3.After saving MQTTBox Client, your device shoold appear as “Connected” on Cervello as the below figure. |
| | | |
| [[File:Networking_rutos_configuration_examples_MQTT_client_status_1.png|border|class=tlt-border]] | | [[File:Networking_rutos_configuration_examples_MQTT_client_status_1.png|border|class=tlt-border]] |
Line 223: |
Line 230: |
| 2.Paste Copied Device data from Point 1 to MQTTBox | | 2.Paste Copied Device data from Point 1 to MQTTBox |
| <ol> | | <ol> |
− | <li>Device should be appeared as “Connected” at “MQTTBox”</li> | + | <li>Device shoold be appeared as “Connected” at “MQTTBox”</li> |
| <li>Paste Device Topic at “Topic to publish” field</li> | | <li>Paste Device Topic at “Topic to publish” field</li> |
| <li>Paste the “Payload” at “Payload” with format “{"data": {"key": value}}”</li> | | <li>Paste the “Payload” at “Payload” with format “{"data": {"key": value}}”</li> |
Line 233: |
Line 240: |
| </ol> | | </ol> |
| | | |
− | 3.Once you publish, you should find your received Telemetry on “Device Details” telemetry Tab. | + | 3.Once you publish, you shoold find your received Telemetry on “Device Details” telemetry Tab. |
| | | |
| [[File:Networking_rutos_configuration_examples_Telemetries_1.png|border|class=tlt-border]] | | [[File:Networking_rutos_configuration_examples_Telemetries_1.png|border|class=tlt-border]] |
Line 278: |
Line 285: |
| | | |
| | | |
− | ===Rule engine=== | + | ===Role engine=== |
| ---- | | ---- |
| | | |
− | Step 1: Create Rule | + | Step 1: Create Role |
| | | |
| [[File:Networking_rutos_configuration_examples_automation_1.png|border|class=tlt-border]] | | [[File:Networking_rutos_configuration_examples_automation_1.png|border|class=tlt-border]] |
| | | |
− | Step 2: Configure Rule | + | Step 2: Configure Role |
| | | |
| <ol> | | <ol> |
− | <li>Add Rule Name</li> | + | <li>Add Role Name</li> |
− | <li>Choose Rule Occurrence (if you choose “Set Count”, the rule will be disabled after exceeding occurrence count).</li> | + | <li>Choose Role Occurrence (if you choose “Set Count”, the role will be disabled after exceeding occurrence count).</li> |
| </ol> | | </ol> |
| | | |
| [[File:Networking_rutos_configuration_examples_add_configure_1.png|border|class=tlt-border]] | | [[File:Networking_rutos_configuration_examples_add_configure_1.png|border|class=tlt-border]] |
| | | |
− | Step 3: Choose Rule Trigger, Condition and Action. | + | Step 3: Choose Role Trigger, Condition and Action. |
| | | |
| [[File:Networking_rutos_configuration_examples_trigger_1.png|border|class=tlt-border]] | | [[File:Networking_rutos_configuration_examples_trigger_1.png|border|class=tlt-border]] |
| | | |
| [[File:Networking_rutos_configuration_examples_action_1.png|border|class=tlt-border]] | | [[File:Networking_rutos_configuration_examples_action_1.png|border|class=tlt-border]] |