Ci40 Onboarding scripts

Visit us at forum.creatordev.io for support and discussion.

This project provides a set of scripts that allows you to do onboarding of your Ci40 either through a web interface or using an Android app. Onboarding is the process of connecting your Ci40 to the Device Server.

There are three main components:

Luci onboarding module that integrates with LuCI interface.
JsonRPC API that exposes couple of methods that can be used to perform onboarding.
Ubus API that exposes a "Creator" ubus object on which some methods can be performed.

Prerequisites

Onboarding scripts depends on following packages:

curl
luci
luci-mod-rpc
libubox-lua
luci-ssl-openssl
uhttpd-mod-tls
avahi-dbus-daemon
avahi-dnsconfd

If you're using Creator Image you should already have these installed, otherwise you can install them using following command:

opkg install curl luci-mod-rpc libubox-lua luci-ssl uhttpd-mod-tls avahi-dbus-daemon avahi-dnsconfd

How to install

Easiest way of installing the Onboarding Scripts is using opkg package manager.

opkg install onboarding-scripts

Alternatively you can compile it yourself.

LuCI onboarding module

This is a module for LuCI that allows you to complete the onboarding of your Ci40 board through a web page. The onboarding module is available on your Luci page under the "Creator" tab. Once you've connected you're Ci40 to the internet you can access it through https://OpenWrt.local/cgi-bin/luci. Follow the on-screen instructions to guide you through the process.

Json RPC API

This component exposes a couple of Json RPC methods through https. The API is accessible through https://OpenWrt.local/cgi-bin/luci/rpc/creator_onboarding?auth=AUTH_TOKEN endpoint. Uhttpd daemon running on Ci40 uses self signed certificate. You may need to tell your client to accept such certificates. In curl this will be the -k parameter.

Authentication

To call any method you need to be authenticated first. To authenticate yourself using JsonRPC call

http://OpenWrt.local/cgi-bin/luci/rpc/auth

with following request body

{
    "id" : 1,
    "jsonrpc" : 2.0,
    "method" : "login",
    "params" : [
        "USERNAME", "PASSWORD"
    ]
}

where USERNAME and PASSWORD are credentials to your board. When successfull this call should return an authentication token which you have to pass when calling other methods.

On a successfull login you should get response similar to this:

{
  "id": 1,
  "jsonrpc": "2.0",
  "result": "13f749ec6789ae6032eda560139ccded"
}

doOnboarding

Calling this method will connect your Ci40 board to Device Server. You need to know Your api key, api secret and device server url in advance. These can be obtained from the Developer Console API key page.

ENDPOINT_NAME defines how your device will be named on Device Server.

Return true on success, or error on failure.

Example request

{
  "id": 1,
  "jsonrpc": "2.0",
  "method" : "doOnboarding",
  "params" : [
    "http://deviceserver.flowcloud.systems",
    "YOUR_API_KEY",
    "YOUR_API_SECRET",
    "ENDPOINT_NAME"
  ]
}

Example response

{
  "id": 1,
  "jsonrpc": "2.0",
  "result" : true,
  "error" : null
}

isProvisioned

Return true if this board is Provisioned, false otherwise

Example request

{
  "id": 1,
  "jsonrpc": "2.0",
  "method" : "isProvisioned",
  "params" : []
}

Example response

{
  "id": 1,
  "jsonrpc": "2.0",
  "result" : true,
  "error" : null
}

unProvision

Disconnects Ci40 from device server and removes configurations set by onboarding method

Example request

{
  "id": 1,
  "jsonrpc": "2.0",
  "method" : "unProvision",
  "params" : []
}

Example response

{
  "id": 1,
  "jsonrpc": "2.0",
  "result" : true,
  "error" : null
}

boardName

Return board name set during onboarding process or null if board is not yet provisioned to device server.

Example request

{
  "id": 1,
  "jsonrpc": "2.0",
  "method" : "boardName",
  "params" : []
}

Example response

{
  "id": 1,
  "jsonrpc": "2.0",
  "result" : true,
  "error" : null
}

boardInfo

Return set of key : value pairs with some board details

Example request

{
  "id": 1,
  "jsonrpc": "2.0",
  "method" : "boardInfo",
  "params" : []
}

Example response

{
  "id": 1,
  "jsonrpc": "2.0",
  "result" : {
    "hostname" : "OpenWrt"
  },
  "error" : null
}

Ubus API

Last component of onboarding-scripts is a ubus object "creator" which for the time being exposes only one method.

generatePsk

Once onboarding process is completed this method can be used to generate new PSK on device server.

ubus call creator generatePsk '{}'

Example response

{
	"pskIdentity": "zyi9HHC4H0C2k5ygYOWSFA",
	"pskSecret": "1988D523D88F480B15A98EBE27E1141CA41F30FD74E52C96ABC75AEC2AA49938"
}

KNOWN ISSUES

To be able to perform onboarding through LuCi interface two conditions must be met:

Ci40 hostname has to be set to "OpenWrt". It's default behaviour, if you didn't change it then it's fine.
Only single Ci40 board can be in your network

CONTRIBUTING

If you have a contribution to make please follow the processes laid out in contributor guide.

creatordev / ci40-onboarding-scripts Goto Github PK