Dashboard Icon

Helium Dashboard


Helium's Dashboard interface allows you to manage your fleet of connectivity-enabled devices and data usage.

Dashboard allows you to easily visualize the traffic and data usage of your devices. To purchase devices, visit our Store. For large volume hardware purchases, please contact support@helium.com.

To get started, go to Helium Dashboard and create a free account or sign in.

If you already have Helium Hardware you’re ready to activate your first device.

Activating Atoms and Elements

The first thing you’ll need to do is activate your Helium Atom. This will need to be done for each new Atom you deploy. We highly recommend activating your device on Dashboard before working on Hardware.

Activating an Atom

  1. In Dashboard, click Add Atom or click + in the navigation menu
  2. Give your Atom a name
    • This name does not need to be unique and can contain special characters
  3. Enter the MAC ID (last 4 digits)
    • Find the atom ID on the hardware sticker [image]
  4. Enter the HVV
    • Find the 4-digit identifier number here [image]
  5. Add Tags (optional)
    • Give the Atom tags for grouping or identification purposes. Typical tags can be for location, the type of sensor it’s attached to, or the owner. Later you’ll be able to use these tags to search.
  6. Click Activate Atom to continue. Your Atom subscription will also be activated.
  7. The Atom is now activated. Don't forget to place the Atom on the appropriate adapter and install the hardware libraries for your device.

Activating An Element

Helium Elements are responsible for creating the local area wireless network and routing encrypted traffic to and from Helium devices.

  1. Click Add Element or click + in the navigation menu
  2. Give your Element a name
    • This name does not need to be unique and can contain special characters
  3. Enter the MAC ID (last 4 digits)
    • Find the atom ID on the hardware sticker [image]
  4. Enter the HVV
    • Find the 4-digit identifier number here [image]
  5. Add Tags (optional)
    • Give the elements tags for grouping or identification purposes. Typical tags can be for location, the type of sensor it’s attached to, or the owner. Later you’ll be able to use these tags to search.
  6. Click Activate Element to continue.
  7. The Element is now activated. Don't forget to connect the power and Ethernet (optional, only applies if you purchased an ethernet-only Element)

Moving Atoms or Elements to another Team

Helium makes it easy to transfer ownership of Atoms, Elements, and Channels from team to team.

Transferring Ownership of an Atom
Transferring Ownership of an Element
Transferring Ownership of a Channel


Teams

Teams are the top level organization for Users, Atoms, Elements, and Channels. Each team has its own setting and billing information. Atoms and Elements can only belong to one team.

Creating a New Team

Every Dashboard account comes with a Personal Team that allows 1 user only. To collaborate with others, you’ll need to create a new Team.

  1. In the left navigation menu, click Personal at the top. A dropdown will appear that shows what team(s) you’re a part of.
  2. Click the + icon
  3. In the form that appears, give the team a unique name
  4. Click Create a New Team

Inviting Others to a Team

invite_dialog DocImg

  1. In the left navigation menu, click Team Settings
  2. In the Access section, click Invite Member
  3. Add an email address and select a Role
  4. Click Invite

New users will receive an invite email and must accept before using Dashboard.

Types of Roles and Permissions

Roles Permission
Member Role Cannot transfer Atoms, Elements, or Channels
Cannot revoke access from any user
Can invite members and assign as members
Admin Role Can transfer Atoms, Elements, and Channels from one team to another
Can revoke member access
Can invite members and assign members or admin
Can add and edit Billing Settings
Owner Role Can transfer Atoms, Elements, and Channels from one team to another
Can revoke admin and member access
Can invite members and assign as members, admin, or owner
Can add and edit Billing Settings

Belonging to more than one Team

A Helium Dashboard User can belong to any number Teams using a single email. The team toggle in the left navigation menu enables you to switch between teams on the fly without re-authentication.

The Personal Team

The Personal Team is the default team created for each user’s email. You can do everything in a personal team that collaborative teams can do, just without other users.

Removing Members from a Team

To remove a member from a team, you’ll need Owner or Admin permissions. 1. Go to Team Settings and locate the Access section 2. Click Revoke Access 3. Confirm the action

Changing User Permissions

  1. Go to Team Settings and locate the Access section
  2. Find the team member you want to update and update Role dropdown

Note: Depending on your role, you may not have the permissions to update some users. See Types of Roles and Permissions


Atoms

Helium Atoms are part of the connectivity solution that allows an embedded device (i.e. mbed, Arduino) to transmit sensor data to a cloud platform of your choice via Channels.

The Atom comes in two version: the Atom Prototyping Module and the Atom Surface Mount Module. Typically, the Atom Prototyping Module is added to an adapter board then attached to an embedded device like a Raspberry Pi, Arduino, or mbed board for prototyping (though it can be used in production deployments). When ready to scale, the Atom Surface Mount Module can be soldered directly to any board of your choice. This reduces the hardware footprint.

Adding an Atom

Atoms must be activated in Dashboard before they can transmit data. See Activating an Atom

Atom Information

Go to Dashboard > Atoms to manage your entire fleet of Atoms. The table shows the important information about an Atom at a glance. To view Atom details, click on an Atom.

Navigating Atoms in Detailed View

Quickly scan through Atom Details without going back to the Atoms page by clicking the arrow buttons located on the top right of the page, just below your Login name.

Changing the Atom Name

  1. Go to Dashboard > Atoms
  2. Locate the Atom
  3. In Atom Details, edit the name in Atom Name
  4. Click Save Changes

Atom Details

UI What it means
Atom Name Name of the Atom
Atom MAC Mac address of the Atom, a unique alpha-numeric string of character. This cannot be changed.
Status Status can be Configured or Not Configured. Configured Atoms have successfully communicated with the device, are activated, and can send data to the cloud. Not Configured Atoms have not communicated with the embedded device but are activated.
Signal Low, Medium, or High
Last Reported Date/time of the last message sent from the Atom
Connected To Name of the Element the Atom is connected to. Click on the Element name to view its Details
Created Date/time of atom activation

Atom Tags

Tags are useful to organize your deployment. Use it to add metadata about the sensors, its location, its owner, or other interesting details. See How to create and use Tags.

Deactivating an Atom

Deactivating an Atom takes the Atom offline, which means data from your device will no longer be routed to your Channels. We only recommend this action if you’re not in active development or actively using the data.

  1. Click on the Atom you want to deactivate to view the Atom’s Details page
  2. Toggle the Active button and click Save Changes
  3. You will see a prompt to confirm deactivation. Click OK to continue or Cancel to keep the Atom online.

Once deactivated, this Atom will no longer send data through Helium. This Atom will also be removed from your monthly subscriptions.

Reactivating an Atom

To reactivate an Atom , click its name to view the Details page and toggle the switch to On. (Note: Your monthly Atom subscription will increment.)

Atom Event Logs

Users can see a detailed history of events related to an Atom via logs. Logs can be filtered by typing in the search box.

Types of events

Event Type Explanation
Activated Atom has been activated by a user. Shows the email address of the user and date/time.
Deactivated Atom has been deactivated by a user. Shows the email address of the user and date/time.
Data sent to Channel Atom has sent data to a Channel. Shows the message size, date/time, and the name of the Channel.
Channel does not exist Atom tried to send data to a Channel that does not exist.

Data Usage

Shows the total amount of data sent from the Atom to Channels.

Transfer Ownership

Dashboard users with Admin or Owner permissions are able to move Atoms to another Team of which they're also an Admin or Owner. When transferring Atoms, the new team will be responsible for the subscription cost.

  1. Go to Atom Details and scroll to the Transfer Ownership section
  2. Select the new Team
    • Note: If you don't see a Team listed, you may not have sufficient permissions to transfer ownership.
  3. Click Transfer

Elements

Helium Elements create the local area wireless network and route encrypted traffic to and from Helium devices.

Adding an Element

Elements must be activated in Dashboard before they can route data. See Activating an Element.

Element Information

Go to Dashboard > Elements to manage your fleet of Elements. The table shows the important information about an Element at a glance. To view Element Details, click on the name of an Element.

Map View

Map View displays your team's deployed Elements on a map. Each marker denotes one Element; click on a marker to view more information about the Element.

Navigating Elements in Detailed View

Quickly scan through Element Details without going back to the Elements page by clicking arrow buttons located below your login name.

Changing the Element name

  1. Go to Dashboard > Elements
  2. Locate the Element and click its name
  3. In Element Details, edit the name
  4. Click Save Changes

Element Details

View a Element's details at a glance.

UI What it means
Element Name Name of the Element
Element MAC Mac address of the Element, a unique alpha-numeric string of character. This cannot be changed.
Status Online or Offline. Offline Elements do not have internet access and cannot send data to the cloud.
Signal Low, Medium, or High
Last Reported Date/time of the last message sent
Atoms Shows the number of Atoms connected to this Element. Click on the number to view the full list.
Created Date/time of Element activation

Element Tags

Tags are useful to organize your deployment. Use it to add metadata about the access point, its location, its owner, or other interesting details. See How to create and use Tags.

Deactivating an Element

Deactivating an Element takes the Element and cellular connectivity (if available) offline. Any Atoms connected to this Element won’t be able to route data to channels. We only recommend this action if you’re not in active development or aren’t using the data from these Atoms and Elements.

  1. Click on the Element you want to deactivate to view the Element’s Details page
  2. Toggle the Active button and click Save Changes

Reactivating an Element

To reactivate an Element, click its name to view the Details page and toggle the switch to On.

Element Location

Helium features two different ways to retrieve an Element’s location. Users can manually enter a physical address for their Element by editing its location, or, allow Helium to automatically geolocate.

By default, Helium will use the manually entered address. If no address is entered, Helium will attempt to automatically geolocate.

Add a Physical Location

  1. Click Set Address
  2. Enter the address
  3. Click Save Location

Element Event Logs

View a detailed history of an Element's activity using Logs. Logs can be filtered by typing in the search box.

Types of events

Event Type Explanation
Activated Element has been activated by a user. Shows the email address of the user and date/time.
Deactivated Element has been deactivated by a user. Shows the email address of the user and date/time.

Connected Atoms

View a list of Atoms connected to the Element. Click on an Atom name to explore the Atom details.

Data Usage

Shows the total amount of data sent from the Atom to Channels via the Element.

Transfer Ownership

Dashboard users with Admin or Owner permissions are able to move Elements to another team of which they're also an Admin or Owner.

  1. Go to Element Details and scroll to the Transfer Ownership section
  2. Select the new Team
    • Note: If you don't see a Team listed, you may not have sufficient permissions to transfer ownership.
  3. Click Transfer

Tags

Tags are free form text for organizing and grouping Atoms, Elements, and Channels. They can also be used in global searches across your entire Team. Tags can be used across Atoms, Elements, and Channels with suggested Tags to organize devices quickly.

Stay tuned for exciting features using tags, such as alerts and sending OTA updates based on Tags.

Here are some example tags we like to use:

Create a Tag

  1. Go to Atom Details, Element Details or Channel Details
  2. Start typing text in the Tags box
  3. Press enter to confirm the tags
  4. Click Save Changes

Search

Search is available in Dashboard, accessible by the magnifying glass icon located in the top right corner in Dashboard. Once you filter the results, Dashboard will display all the Atoms, Elements, or Channels matching those requirements.


Channels

Channels are secure methods to route your data from the device to any cloud or private server. Helium has partnered and integrated with the best-in-class Cloud platform solutions like Azure, Google IoT Core, and AWS IoT. Helium is the only connectivity solution that includes both Hardware security and software security, out of the box. Helium uses hardware secured keys to authenticate your device with the Cloud platform solution so your data integrity is never compromised.

By default, the Helium-hosted MQTT Channel is activated and allows users to subscribe to the Channel without installing Client Libraries or editing Client-side code.

Set up a Channel by following our guides:

Coming Soon:

Channel Details

Click on a Channel name to view its details at a glance. Channel names are immutable to ensure client-side code linking the Atom to the Channel persists. In order to rename a Channel, create a new Channel with the new name and update the client-side code. Deactivate the old Channel if it’s no longer needed.

Last Message Sent

The date and time of when the last message was sent through this Channel.

Status

The Status of the Channel, will either be OK or ERROR.

ERROR statuses may be a result of the cloud platform returning error codes, the platform is down, or something in the client code is causing the error. For help in debugging any error issues, contact support@helium.com.

Channel Tags

See How to create and use tags

Deactivating a Channel

Deactivating a Channel temporarily prevents data from sending to that Channel while maintaining the Channel credentials and Event logs. Reactivating the Channel allows the flow of data to go through once again.

  1. Click on the Channel you want to deactivate to view the Channel's Details page
  2. Toggle the Active button and click Save Changes

Event Logs

Channel event logs shows all activity that is routed through the Channel. Each log will indicate who originated the message, the size, date/time, and whether the message succeeded.

Types of Events

Event Type Explanation
Sent to Channel Name A log that something was sent to the Channel
Channel Activated by user The Channel was activated by a user
Channel Deactivated by user The Channel was deactivated by a user

Transfer Ownership

Dashboard users with Admin or Owner permissions are able to move Elements to another team of which they're also an Admin or Owner.

  1. Go to Channel Details and scroll to the Transfer Ownership section
  2. Select the new Team
    • Note: If you don't see a Team listed, you may not have sufficient permissions to transfer ownership.
  3. Click Transfer

Delete a Channel

Deleting a Channel hard deletes all event logs and credentials for the Channel. Deleting a Channel should only be done if you're confident the Channel is not used by any Atom. If you want to stop data from routing to the cloud platform but keep event logs and credentials, we recommend Deactivating a Channel instead.

  1. Go to Channel Details and scroll to the Delete Channel section. Only Admins and Owners are able to delete a Channel.
  2. Click Delete Channel

Manage Account

Update your account email, password, and turn on two-factor authentication by clicking the avatar in the top right of Dashboard and select Manage Account.