Documentation
Energo IO - IOT plateform
CONNECT MY FIRST DEVICE
  • CHECK THE NETWORK COVERAGE Before any investment, please check the coverage at the location you plan to use your device

  • BUY DEVICE See the list of supported devices to check compatibility with IO Frog.

  • CREATE AN ACCOUNT Go to connect.energo.io and sign up for a new account.

  • REGISTER NEW DEVICE Follow the guidelines to fill the form, pay online for the connectivity, and you are all set!

  • ADJUST SETTINGS AND NOTIFICATIONS We will show you how to get most out of your device here!



REGISTER NEW DEVICE
1. Choose Devices in main menu and click on "New Device"

2. You may optionally check the coverage by entering address or latitude and longitude and press button Check Coverage. The outcome is indicative only and it is based on measurements in radius of 200 metres.

3. Enter Device ID and click Next. ID is a unique hexadecimal code e.g. 14521AF that you can find on your device.

4. Select correct radio zone based on your device location and then choose supplier and specific device type. You may find more details about your device via clicking on icons:

  • Supplier's web
  • Supplier's e-mail
  • Documentation
  • Support

5. Optionally, you can setup notifications to:

  • SMS
  • E-mail
  • Smart devices (push notifications)

6. Enter connectivity details:

  • Device name – Your own name under which you can easily identify your device.
  • Registration in Sigfox backend – choose option "I want to purchase Sigfox connectivity with I/O Frog services".Warning: If you are registering the device that is currently registered in backend.sigfox.com or in other platform, you will not be able to access it there after the registration process is finished because the device will be transferred under IO Frog contract. You will always find a new PAC code in IO Frog that you can use to transfer the device back to backend.sigfox.com or different platform but it will require a new token from the contract.
  • PAC – PAC (Porting Authorization Code) is a one-time activation code you should have received with your device.
  • Subscription program – Choose subscription program based on your specific needs.
  • Add to favourites – You can add the newly registered device to favourites (12 maximum). The favourite devices are listed in the main dashboard.
  • Read General Business Terms and Privacy policy and confirm if you agree.
  • Click Next.

7. Your device is now registered in IO Frog. The next step is to buy Sigfox connectivity. Go to shopping cart to complete the payment.

8. Check items in shopping cart and proceed with the payment by clicking the PayPal button.

Once phone number/email entered, two payment options become available:

  1. Paypal
  2. Credit or debit card

10. Device is registered. If the processed failed, please contact us

11. Switch to the Main dashboard. Here you may have up to 12 devices per page. Now you can activate your device and send the first message. This process differs based on your device type.

CONNECTING DEVICES WITH EXISTING CONNECTIVITY


If you have your own Sigfox connectivity and your device is already registered in backend.sigfox.com, you can still benefit from I/O Frog platform. Because in such case we do not have an access to your contract in backend & device details, there are some limitations:

  • You have to setup callbacks to I/O Frog platform yourself (see details bellow)
  • Checking your connectivity contract conditions is outside our possibilities. We cannot provide you consumption reports or backend details.
  • You will get 20-days free access to IO Frog platform. After this evaluation period, you can buy a full access based on our price list.
Guidelines

1. The first steps are same as in New device registration, where you choose option "I already have Sigfox connectivity and access to backend.sigfox.com".

  • Choose 20-days free access.
  • After you click Next, registration process in Energo IO is completed.
  • You have to create custom callbacks in backend.sigfox.com, so the messages sent by your device will be directed to Energo.IO



2. Login to https://backend.sigfox.com/ using your credentials and choose Device Type in main menu:


3. Click on the name of your device type, in case of SimpleHW DevKit, choose Simple-Hardware_DevKit_1.

4. Choose Callbacks in left menu and click New in top-right corner.

5. Choose option Custom callback

6. Create callback #1:

  • Type: DATA, BIDIR. You can define only one active BIDIR callback that is necessary to update devices with downlink messages. Alternatively, you can choose UPLINK data type callback but your device will not be updated via downlink.
  • Channel: URL
  • URL pattern: https://connect.energo.io/api/v1/devices/{device}/callbacks
  • Use HTTP metod: POST
  • Content type: application/json
  • Body:

{ "timestamp" : {time}, "type": "data_bidir", "seqNumber" : {seqNumber}, "ack": {ack}, "messages": [ { "key": "payload", "value": "{data}" } ] }

7. After you created DATA_BIDIR callback, it is necessary to activate Downlink by clicking on circle in Downlink column. This is possible only if your device type is set to "Callback" (in device type settings).

8. Create callback #2 in case you want to send Sigfox GEO location to I/O Frog platform – you will be able to add computedLocation only if you have Geo location services on your current Sigfox contract:


{ "timestamp" : {time}, "type": "service_data_advanced", "seqNumber" : {seqNumber}, "messages": [ { "key": "lqi", "value": "{lqi}" }, { "key": "computedLocation", "value": {computedLocation} } ] }

If you have duplicates enabled on your contract, you can add duplicate key:


{ "timestamp" : {time}, "type": "service_data_advanced", "seqNumber" : {seqNumber}, "messages": [ { "key": "lqi", "value": "{lqi}" }, { "key": "computedLocation", "value": {computedLocation} }, { "key": "duplicates", "value": {duplicates} } ] }

9. Create callback #3 in case you want to send service acknowledge messages to I/O Frog:

  • type: SERVICE, ACKNOWLEDGE
  • Channel: URL
  • URL pattern: https://www.iofrog.com/api/v1/devices/{device}/callbacks
  • Use HTTP metod: POST
  • Content type: application/json
  • Body:

{ "timestamp" : {time}, "type": "service_ack", "messages": [ { "key": "acknowledgement", "value": "{downlinkAck}" } ] }

Secure callbacks with 3rd party connectivity Because devices with 3rd party connectivity are already provisioned in Sigfox backend using the original PAC code, there is no possibility to check eligibility of the user to register particular device ID in Energo IO (the original PAC is obsolete and we do not have an access to new PAC code in backend.sigfox.com because of using 3rd party connectivity).

To increase the security, you can optionally add a secretKey attribute to all call-backs. If your callbacks from backend.sigfox.com are secured by such secretKey, you have to enter the same secretKey in Energo IO> Device connectivity > Settings.

WARNING

If the secretKey in Energo IO is missing or different, all callbacks will be rejected!

Example of BIDIR callback using the secretKey:


{ "timestamp" : {time}, "type": "data_bidir", "seqNumber" : {seqNumber}, "ack": {ack}, "secretKey": "tskAwmdnC0RPfQ1NmJNTNXipcZhTYnIK", "messages": [ { "key": "payload", "value": "{data}" } ] }

EXTEND CONNECTIVITY

Find out which devices are about to expire

1. In order to find out which device's platform connectivity is going to expire soon, go to Diagnostic Dashboard and use filters at the top right corner to display only devices that expire soon or already expired.

(*You can skip this step if you are well aware of the expired device which needs to be extended)

Select expired device

2. Then you can either go to Main Dashboard and list through all devices until you see notification "PLATFORM ACCESS EXPIRED" with button "EXTEND" for immediate extension.

Or check the "Connectivity" details through the device menu (3 dots right top corner of each device).

(*You can also select desired device via All devices Dashboard through the device menu, hit the 3 dots to open device menu and select Connectivity)


Select expired device

2. Then you can either go to Main Dashboard and list through all devices until you see notification "PLATFORM ACCESS EXPIRED" with button "EXTEND" for immediate extension.

Or check the "Connectivity" details through the device menu (3 dots right top corner of each device).

(*You can also select desired device via All devices Dashboard through the device menu, hit the 3 dots to open device menu and select Connectivity)


Choose the type of connectivity

3. Once you have selected device with expired connectivity you can choose type of connectivity you want to extend. Just check the hitbox of one of the following options:

  • Connectivity and Platform (Transferring device from 3rd party connectivity provider requires current PAC code you can find in backend.sigfox.com (NOT the one that is on your device because that is already obsolete).
    • Do not forget to choose the connectivity Product – Basic, Plus or Ultra.
  • Platform only
(*In this example we selected Platform only and hit Extend button)

If you have a "Coupon" use it here.

Checkout

4. Then just hit the "EXTEND" button and go to Shopping Cart to continue with checkout.

Proceed with the payment by clicking the "Paypal" button and enter your phone number or email. Then two payment method becomes available and you can choose between credit/debit card or Paypal.

After successful payment, you will be provided with an invoice confirming your order and payment.

Android Application
Go to Google Play and download Energo.IO
    The main features:

    1. Free push notifications
    2. Device with the latest message on the top
    3. Details, map, subscription, and message history
    4. Enable/disable push, SMS, and e-mail notifications
    Check the examples of using the app in real live scenarios.

    Access right for user
    The user can manage different access right :
    • Basic
    • Expert
    They only "filter" the features that are potentially accessible by the user (based on the rights the user was given by the administrator). Every user can change the user level in User profil by himself.

    Access right for user
    When you log in and your user is not reconnized, please check the correct spelling of your username, it is sensitive to capital letter and should be as per your registration

    ORGANISATION OF DEVICES, USERS, AND GROUP SETUP
    All devices are organised into groups. One device may belong to one group only. The purpose of groups is to:

    1. Organize all devices in a tree-like structure primarily based on the ownership.
    2. Define all features once on the group level and apply them to all devices in the group.
    3. Manage users that have a specific access to selected group granted by the owner or manager of the group.
    Groups are accessible right from the top menu where you see the name of the current group. There are 3 sub-menu items under the current group name:

    • Billing – check the orders, update billing data, increase SMS credits
    • Settings – user management and management of all group features including Tags, Geoplaces, Notification rules, Forwardings, Public Channels
    • Change the group – change the current group. Here you will see your own group (if you have one) and all groups you have an access to, e.g. groups you were invited t
    SETTINGS

    • Create sub-groups, manage users and devices
    • Tags to organise a large number of devices inside one group
    • Geo-places to define fences for asset tracking
    • Public channels to share your devices publicly
    • Notification rules to receive only the notifications important to you
    • Data forwarding to send messages to others servers and backend systems

    Group management In Group management you can see your own group in the list of groups (first group on the list) as well as all groups you were invited into (with specific permissions).

    • Create sub-groups if you need a new group with new set of users, tags, geoplaces, notification rules, public channels, and forwardings
    • Grant/remove access to other users
    • Manage each user permissions
      • Predefined user-level template (Owner, Device manager, Guest, Custom)
      • Restrict the access to the specific device
    • Move devices across the groups you have an access to
    There are 2 types of groups

    1. Contract group – the main group that besides devices may also contain: billing data, orders/invoices, credit, and shopping cart. Every contract group must have at least one owner (= user with full ownership rights). You cannot delete the group if there are orders or SMS credit left.
    2. Standard group – you can create any number of groups and sub-groups under contract group for better organization of devices.

    Tags Tags are here to help you organize a large number of devices inside one group.

    1. Select the group where you want to create new Tags
    2. Name the tag, choose the color
    3. Assign devices and hit the button add/update

    Geolocations Select and name the areas on the map that will be used in processing of the incoming messages and in the notification rules. You can be notified when your device arrives in it or leaves specific geoplace.

    How-to work with geoplaces:

    1. Create a new geoplace in group Settings > Geoplaces
    2. Filter devices by geoplaces on Tracing dashboard
    3. Check location of specific device in Message history
    4. Add Arrival / Departure conditions in Notifications rules

    Public channels

    Share your devices with other people without a need of having an account in IO Frog. Simply copy the specific URL and share it!

    • Define a public channel under specific group in Settings > Public channels
    • Describe the channel and assign as many devices you like
    • Share your devices via Public channel URL

    Notification rules

    Notification rules enable you to define rules that will be applied to all or selected devices of specific type inside the group. Notification rules enable to set:

    • Multiple recipients
    • E-mail, SMS, Push notifications
    • Custom template using pre-defined variables
    • Specify time range and day of the week
    • Multiple conditions with AND/OR boolean logic

    Alert Management

    To setup an alert choose the correct Group and go to Notification rules and do following steps:
    1. Fill the title of the alert
    2. Choose the name of the vendor and the right model of the device
    3. Choose if you want to apply the rule to the specific devices or to the whole group
    4. Choose the notification type you want to receive (email, sms, push)
    5. Choose the convenient schedule of alert notification
    6. Choose conditions of the alert and click Add


    Data forwarding

    Push messages to own backend systems, BI solutions or other servers via REST API.

    • Define forwarding to your own server
    • JSON content type, POST method
    • Custom headers enables to add authorisation tokens
    • Support for basic customisation
    • Check status of the last forwarding – status code and result