afKaiterraCloudExt

Kaiterra Cloud Ext is a SkySpark connector for ALL Kaiterra Laser Egg and SenseEdge devices.

Officially endorsed by Kaiterra!

The Kaiterra Cloud extension is highly optimised to connect with the Kaiterra Cloud Dashboard and efficiently synchronise SkySpark data points from your Kaiterra devices.

Kaiterra Cloud Ext works in the context of both personal dashboard accounts as well as larger organisation based accounts - with no additional configuration necessary!

The Kaiterra Cloud extension provides support for:

• Learn functionality - Browse and bind device points in the SkySpark Connector App
• Current values - Poll the Kaiterra Dashboard for current sensor values
• History sync - Download previous history data for device points in bulk
• Two-Factor Authentication - Have 2FA enabled on your Kaiterra account? No problem!
• Organisation accounts - Works with both personal and organisation based accounts
• Test devices - Evaluate the connector with Kaiterra's own test devices

This connector has been developed for SkySpark v3.1.4 or later.

Kaiterra Cloud Ext is FREE to download and evaluate for up to 10 points. Watch our video tutorial to understand how easy it is to use and how to connect to Kaiterra's test devices on the cloud.

Fortified with Fantom! Robust, secure, and optimised, the Pelican extension boasts the following features:

• Passwords removed from HTTP logs to keep your credentials secure
• Use of Kaiterra batch APIs to reduce IO overhead
• HTTP 1.1 Keep-Alive Pipelining to reduce wasteful socket connections

Kaiterra Cloud Ext is powered by Fantom Factory's own internal EasyConn and HTTP Client libraries.

Contents

• Quick Start
• Usage
  • Evaluation
  • Test Devices
  • Device Management
  • Two-Factor Authentication
  • Debugging
• Licensing
  • Evaluation Mode
• Disclaimer
• Special Mentions

Quick Start

1. Create an account on the Kaiterra Dashboard
2. Install afKaiterraCloudExt (use SkySpark's Install Manager)
3. Use the SkySpark Connector App to create an instance of afKaiterraCloudExt connector
4. Set your Kaiterra Dashboard credentials in the connector record
5. Use the SkySpark Builder App to browse the test devices and bind points

Usage

The Kaiterra Cloud Ext uses the SkySpark connector framework to provide synchronisation features with your organisational and / or personal Kaiterra Laser Egg and SenseEdge devices.

After creating an account on the Kaiterra Dashboard the same login credentials may be used by the Kaiterra Cloud connector.

The connector Learn tree will follow any Organizational structure (if present), and personal devices are displayed under the folder called "Personal".

One connector instance can service ALL the devices in a given account. And indeed, it is more effecient to do so; because where possible, all HTTP calls to the Kaiterra REST API are grouped and optimised and make use of their "batch" feature.

Evaluation

The Kaiterra Cloud extension may be evaluated without a licence, and allows up to 10 points to be bound, synced, and trended for up to 30 days.

Test Devices

Kaiterra provide access to two devices, each with 4 or 6 data points. This lets you practise binding, syncing, and trending data points before you even own any Kaiterra devices!

The Kaiterra test devices, Edmundston Sensedge and Kim Kardeggian, may be found under the "Test Devices" folder in the Connector learn tree.

Remove the afKaiterraCloudTestDevices Marker tag from the Connector record to prevent test devices from appearing in the Connector learn tree.

Device Management

Use the Kaiterra Dashboard to manage your Kaiterra devices. Should you add, remove, or update the details of any device - ensure these changes are reflected in any bound SkySpark points.

This is a manual process and does not happen automatically!

Two-Factor Authentication

Should your login credentials for the Kaiterra Dashboard be configured to require Two-Factor Authentication, the account can still be used with the Kaiterra Cloud Extension.

Enter your username and password in the Connector record as usual. Then obtain a 2FA code (usually from a phone or device app) and enter it with the following Axon function:

read(afKaiterraCloudConn).afKaiterraCloud_submit2FaCode("<2FA-Code>")

The credentials obtained from the 2FA code will be valid for 30 days (or until SkySpark is restarted - whichever the sooner). After that period, the Connector will need to be re-authenticated with a new 2FA code to continue communicating with Kaiterra REST API.

Debugging

Use the "Details" tab in the Connector App to view stack traces and other details, to help diagnose connector-related errors.

Licensing

Kaiterra Cloud Ext is a commercial product and requires a licence to be purchased to run in production.

Licences for Kaiterra Cloud Ext are tied to a SkySpark installation / host ID. This means to use Kaiterra Cloud Ext on multiple SkySpark installation will require multiple licences; one per installation. You will need to enter your SkySpark licence ID when purchasing, see Where is my SkyArc Installation ID? for details.

Licences specify a maximum number of Kaiterra points that may be bound on any SkySpark instance, across ALL SkySpark projects. Points from multiple licences are additive.

Purchased licences are available from the My Licences page in StackHub and should be downloaded to the /var/lic/ directory of your SkySpark installation.

Minor updates to Kaiterra Cloud Ext may be provided free of charge, but major updates will require a new licence to be purchased.

The End-User License Agreement ("EULA") is contained with the downloaded .pod file.

For support and comments, please email ----------------------.

Evaluation Mode

If Kaiterra Cloud Ext does not find a valid licence, it enters into an evaluation mode whereby a maximum of 10 Kaiterra points may exist for a period of 30 days; after which Kaiterra Cloud Ext will throw a licence fault.

Evaluation mode is designed for developers to try out various features of Kaiterra Cloud Ext to assess its suitability for purpose.

Disclaimer

The software is provided "AS IS" and the author disclaims all warranties with regard to this software including all implied warranties of merchantability and fitness. In no event shall the author be liable for any special, direct, indirect, or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with the use or performance of this software.

Special Mentions

Special thanks go to Kaiterra for endorsing this SkySpark extension and providing guidance on their REST API.