Edge Tutorial

Pre-requisites:

  1. You have created a developer account with ClearBlade (https://platform.clearblade.com).
  2. You have logged in with the developer account and created a System on the ClearBlade platform.
  3. You have created User accounts on the ClearBlade platform.

STEP 1: Create an Edge

  1. On your ClearBlade Platform, Click on the + Add Edge button which is highlighted below.

  2. Give a name to your edge with a suitable description

  3. Finally, click on the Create button to create the edge.

  4. The edge should appear in the list.

  5. You can view the settings for an edge, by clicking on the Settings icon button to the right of a particular Edge.

  6. You can view these important settings for your Edge.

  7. This concludes STEP 1 of Creating a new Edge and viewing important settings about the newly created Edge. This information will be used in subsequent steps.

STEP 2: Install and Start an Edge

  1. Click on the Set up instructions icon button for the Edge that was created in the previous step

  2. Select the operating system the Edge will be installed on from the Target dropdown in the set up dialog If the target operating system you wish to install the edge on is not listed, we recommend you install VirtualBox (or any other virtualizer) and create a virtual machine with one of the target operating systems listed in the dropdown.

  3. Once the operating system has been selected, commands will be displayed that can be used to download, unzip, install and modify permissions for an edge installation

  4. Open a terminal prompt on the target operating system and download the Edge executable using the Download,Unzip,Install, and Permission commands listed

    • For your convenience, you can also click the Copy icon to have the command copied to your clipboard.
  5. Scroll to the bottom of the dialog to the Start section

  6. Enter the IP address of the machine the Edge was installed on into the Edge IP field

  7. Click the Copy icon to the far right of the start script field to have the Edge startup command copied to the clipboard

  8. From the terminal prompt, cd into the directory where Edge was installed (typically /usr/local/bin on Mac OS and Linux)
    cd /usr/local/bin

  9. Paste the startup command into the terminal window and run it

Flags:

A complete listing of the flags that can be used when starting the Edge can be found here

  1. -parent-system
    • The System Key for parent system on which Edge is created.
  2. -novi-ip
    • The IP address/Hostname of your ClearBlade Platform (Without ‘Http://’ or ‘Https://’)
  3. -edge-ip
    • The IP address/Hostname of your Edge (Without ‘Http://’ or ‘Https://’)
  4. -edge-cookie
    • Click on the Show Edges button for the appropriate System and view the settings for an edge, by clicking on the Settings icon button.
    • The -edge-cookie is the Token represented in the Settings window below.
  5. -edge-id
    • Click on the Show Edges button for the appropriate System and view the settings for an edge, by clicking on the Settings icon button.
    • The -edge-id is the System Name represented in the Settings window below.

STEP 3: Add & Customize Devices

Add Devices

  1. Click on the Devices button in the side navigation bar

  2. You can add a new Device by clicking on the + Add Device button, as highlighted below.

  3. Select your preferences and click on the Create button.

  4. You will see a newly created device as above.

Additional Functionality

Update Device State

  1. Go to the settings icon next to the name of the device and click Settings

  2. Lets assume the temperature state be in units of Fahrenheit. In the setting dialog, you can set the Temperature Sensor state to be 100 Fahrenheit and click Update.

Add columns to Devices

  1. You can add some additional properties to your device by clicking on the Edit Columns button.

  2. This will add some properties as Columns to your Device table.

  3. Suppose, you want value of the temperature sensor to be in different units of measure. You can add additional columns to represent the different units of measure.
    NOTE: Additional columns can accept only String type values.

  4. In the above example, we also want the value of temperature sensor to be in degrees celsius along with original value of degrees Fahrenheit . We have added a column named Celsius which accepts data of type String and it shows us the degrees Celsius value of the Temperature Sensor device.

  5. You can see that the additional column has been added at the end of the columns list.

Delete Device

  1. You can also delete the device by selecting the checkbox in front of the device that you want to delete and clicking on the Delete Row button.

  2. Click Confirm when the prompt appears

STEP 4: Message at Edge

Messaging at the Edge is similar to Messaging using the ClearBlade platform. This minimizes developer ramp-up time by sharing a familiar design.

If you are new to Messaging via the ClearBlade Platform, please see the Messaging Docs