User guide

User guide for Yggio

Create an account in Yggio

How to create your account

  1. Open Yggio webpage (Ygg.io) in your browser

  2. Press the ”Create an account” button

  3. Enter a new username and password and check the Accept Terms and Policy box

  4. OPTIONAL: Select the visibility of your account, making your account visible or invisible for other users

  5. Press the "sign up" button to create your new account

Control Panel

Navigate to Control panel

  1. Log in to your account

  2. After you have logged in you should be directed to the Control panel

Adding devices to Yggio

How to connect an ICPE Z-Wave gateway to Yggio:

  1. Login to Yggio with your username and password

  2. Navigate to IoT-nodes on the left side

  3. Press the New IoT-Node button in the top left corner

  4. Choose Z-Wave Gateway

  5. Enter the Z-Wave Gateway Mac-address (Provided on bottom of ICPE) and press next

  6. Give the Gateway a name and press Next

  7. On Manage access rights press Next

  8. On Overview press Save

  9. You should be able to see your device if you filter for Z-wave gateway or search for the name it was given

  10. Check if the gateway status is ”Gateway online”

How to include/exclude a Z-Wave device:

  1. Locate your newly added Gateway in the IoT-node tab with filtering by Z-wave gateway

  2. Press on your Gateway to open viewing popup window

  3. Navigate to Z-wave include/exclude tab

  4. Change mode to exclude with the crossing arrows

  5. Press ”Start exclude”

  6. Trigger the device for include/exclude

  7. Confirm that you get a message saying your device is successfully excluded

  8. Change mode to include with the crossing arrows

  9. Press ”Start include”

  10. Trigger the device for include/exclude

  11. Confirm that you get a message saying your device is successfully included

  12. Enter a name for the newly included device node

  13. Save the device and close the popup window

How to connect a LoRa device:

  1. Navigate to ”New IoT-node” on top left corner

  2. Select device type ”LoRa”

  3. Select type “OTAA” or “ABP” as type, depending on your device

  4. Enter device ID (devEui)

  5. Enter Device Address (devAddr) (ONLY ABP)

  6. Enter Network Session Key (nwkSKey) (ONLY ABP)

  7. Enter Application Session Key (AppSKey) (ONLY ABP)

  8. Enter Application Key (appKey)

  9. Go to Step 2 (Details in tour guide) by clicking Next

  10. Enter a suitable name for your device

  11. Select correct model name (translator for your device)

  12. Go to Step 3 (Manage Access on tour guide) by clicking Next

  13. Go to Done step by clicking Next

  14. Click on Save button to save the LoRA device

  15. Find the device by filtering by “LoRa-node” or search for the given name

  16. Click on the device name to open device popup window

  17. Read the device manual for instructions on how to connect your device

  18. When you have connected your device, press the refresh button in the top right corner of the popup window

  19. Check the status of the device. Confirm that the device is reporting and is connected with LoRa gateway

Translators

Adding a translator for a device

  1. Locate your device in the list manually or use the filter to search for it

  2. Click on the device in the list to open the popup window

  3. Navigate to the Translators tab

  4. Place the cursor over the key icon of the desired translator type if it's listed as an "Available translator". If you are unsure which translator type to choose, select "simple-device" for Z-Wave devices or "simple-lora-node" for LoRa devices. Please note that all devices do not have a translator.

  5. The key icon should now turn into a "+", click on it to add the translator. A notification in the upper right will appear after successfully adding the translator.

  6. Close the popup window

  7. A new device will appear in the control panel with the same name as the original device, except that it will have the translator type at the end of it e.g. "my device-translated (simple-lora-node)".

  8. Click on the translated device and navigate to the value tab, where you now can view the translated values of the device

User groups

Navigate to User groups

  1. Log in to your account

  2. Click on ”User groups” on the left sidebar

Create a user group

  1. Press the “New” button on the top left corner

  2. Enter your group name in the box

  3. Press the “Add” button

Add users

  1. Press the “Manage” button in the top left corner

  2. Find the group you created in the filter box

  3. Select your group

  4. Enter an existing user in the “Add member to group” field box

  5. Press the “Add” button next to the field box

Access rights

Navigate to Access rights

  1. Log in to your account

  2. Click on ”Access rights” on the left sidebar

Give access rights to users and groups

  1. Enter a user or group name in the “Enter username or group name here” field box

  2. Press the “Select” button next to the field box

  3. Give out access rights for a specific device in the list by pressing on the “Read” and “Write” buttons on the right side next to the device names

  4. To give our access rights for many devices, press on the “All”, “Read” and “Write” buttons on the right side above the list

Location Manager

Navigate to Location Manager

  1. Log in to your account

  2. Click on ”Apps” on the left sidebar

  3. Click on ”Location Manager” to go to the Location Manager

Create a Location

  1. In the Location Manager, press on the “New location” button on the left side

  2. Choose a name for your new Location

  3. Choose a description for your new Location

  4. Enter your coordinates or press on the map to select your Location

  5. Once all fields are green, hit the submit button in the bottom left

Add a Blueprint

  1. Go to a Location you created by either finding it on the map and clicking on it, or in the list on the left and click on the name or aim button and press the “go to location” button on the map

  2. When you are “inside” your new Location, press the “New Blueprint” button on the left side

  3. Choose a name for your new Blueprint

  4. Select and/or upload a Blueprint of your new Location

  5. Press the “Create Blueprint” button on the bottom left

Add a device (in Location Manager)

  1. Go to a Location you created by either finding it on the map and pressing on it, or in the list on the left and press on the name or aim button and “go to location” button on the map

  2. On a Blueprint, click on the “Arrow” button next to the “Pen” button

  3. Click on “Add device”, and a dropdown menu will appear

  4. Choose the device you want add to the Blueprint

  5. Press the “+” button on the Blueprint list

  6. On the “Crosshair” button on the map, a red label with your unplaced device should appear

  7. Press the “Crosshair” button and then click on the Blueprint to place the device at the same position as the mouse click

  8. Adjust the position of the device by dragging it to the desired spot

  9. Press on the “Crosshair” button again to go back to the Blueprint

Rule Engine

Navigate to Rule Engine

  1. Log in to your account

  2. Click on ”Apps” on the left sidebar

  3. Click on ”Rule Engine” to go to the rule engine

Create a Rule

  1. Click on the ”Rules” icon in the Rule Engine

  2. Select ”Add Rule” on the middle left side

  3. Enter Rule name

  4. Choose a WHEN trigger. This function defines when something is being done. Enter your values and press on the ”+” button in the middle

  5. OPTIONAL: Choose an IF condition. This function will trigger an Action IF something happens. Enter your values and press the ”+” button in the middle

  6. Choose a DO Action. This function will do something once the WHEN and IF conditions are met. Enter your values and press the ”+” button in the middle

  7. Press on ”Add Rule” in the bottom left side

Create a Condition

  1. Click on the ”Condition” icon in the Rule Engine

  2. Select ”Add Condition” on the middle left side

  3. Enter your Conditions Name

  4. Enter your Conditions value. This function will use the value entered as the trigger

  5. Press the ”Add Condition” button on the left side

Create an Action

  1. Click on the ”Action” icon in the Rule Engine

  2. Select ”Add Action” on the middle left side

  3. Enter your Actions name

  4. Choose what type of Action you need and select it

  5. Enter correct values for your Action

  6. Press the ”Add Action” button on the left side

Create a Contact

  1. Click on the ”Contacts” icon in the Rule Engine

  2. Press the “Add Contact” button

  3. Enter name, e-mail and phone number

  4. Press the “Add contact” button in the bottom left