How to Add a Controller

Applies to CoCoCo platform v1.0.0-rc.31. The steps in CoCoCo were run on that version. Running the installer on your own computer is not part of that test.

What is a Controller?

A Controller is the on-premise bridge between your equipment and CoCoCo. It runs on a computer in your network and keeps a connection to CoCoCo open. Every Controller belongs to a Network: when a Device’s Network contains a Controller, CoCoCo reaches the Device through that Controller.

Before you start

• Create the Network the Controller will belong to (see How to Create a Network).
• You need permission to create controllers (controller:write) and to create controller tokens (controller_token:write).

Add the Controller in CoCoCo

1. In the sidebar, under IoT, click Controllers.
2. Click Add Controller. The page New Controller opens.
3. Under Network, select the Network the Controller belongs to.
4. Enter a Handle. It is required and may contain only lowercase letters, numbers, underscores and hyphens, for example hall-1. The form refuses anything else.
5. Optionally enter a Name and a Description.
6. Tick Active. The box is not ticked by default, and a Controller saved without it is stored as inactive.
7. Click Save.

You’ll see Controller created, and the Controller’s page opens with the tabs Overview, Installations, Tokens and Policy.

Get the installer for this Controller

1. On the Controller’s page, open the Tokens tab.
2. Click Generate Token. The dialog Install Controller opens.
3. Download controller-config.json and save it next to where you will run the installer.
4. Copy the installer command for your system (Linux / macOS or Windows) and run it on the computer that will act as the Controller.
5. Click Done.

The credentials are shown only once. If you close the dialog without downloading the file, generate a new token. The token list shows each token’s expiry date.