Apiotics Portal

Apiotics Portal

The Apiotics Portal provides an easy way to define the functionality of a set of IoT devices. Once the functionality is defined, a web application can easily interact with these devices using one of the Apiotics APIs.

A Hive

At Apiotics, we call a group of IoT devices that are associated with a given web application a Hive. You can have multiple different kinds of IoT devices within the Hive, and many individual devices of each kind of device.

The way that each of these individual devices knows to allow communication between itself and your web application (and to disallow communication to and from other sources) is because they belong to a particular Hive and because your web application has the API keys for that Hive.

To create a Hive, click on "Hives" along the left side of the portal, and then click on "New Hive".

You can call the Hive anything you like, but the format of the name must be in CamelCase. If you're not familiar with CamelCase, it permits only uppercase letters, lower case letters and numbers. No spaces are allowed. You differentiate between different words in the name by capitalizing the first letter of each word. So, if you wanted to name your Hive something like: my awesome hive; in CamelCase this would be: MyAwesomeHive

Once you have given your Hive a name, and clicked "Save" the portal will generate the Hive along with a Public API Key and a Private API Key. You will use these keys to authenticate your web application and permit it to interact with all of the devices in your Hive.

Hive API Keys

Workers

Once you have a Hive, you will want to define at least one Worker for the Hive. A Worker is a type of IoT device. If you are making a smart thermostat application, you will likely have a Worker called Thermostat. To create a worker, click on "New Worker" on your Hive's page.

Then, fill out the name of the Worker (again using CamelCase) and select the hardware device that you want to use to run your Worker on. Apiotics supports a range of hardware, and we're adding more devices all the time. You can add more detailed configuration if you like and then click "Save".

You can view a list of supported devices and see the drivers they support at any time by clicking on Devices on the left side of the Apiotics Portal page.

Drivers

Once you have created a Worker, click on Manage Drivers on the Worker Page to select the drivers you want to use with your Worker.

Manage Drivers

Worker Instances

Once you have a Worker defined and have selected the Drivers you want to use with it, you can then create one or more Worker Instances. From the Worker page, click on "New Worker Instance". This will create a new instance with a status of "provisioned". Each individual IoT device you deploy will have a one-to-one relationship with a Worker Instance. The Instance Id allows you to uniquely identify each device you have in use.

1.1.0
Jason Dahlstrom

Navigation