Astarte Dashboard

Introduction

The Astarte Dashboard is a web-based user interface for managing and monitoring Astarte realms, devices, and configurations. It provides a streamlined way to interact with Astarte's APIs and visualize data in an intuitive manner. Users can register devices, define interfaces, set up triggers, and manage realm settings through a graphical interface.

Accessing the Dashboard

To access the Astarte Dashboard, navigate to the URL of your instance (e.g., https://dashboard.astarte-test.seco.com/). You will need:

• Realm Name: The specific name of your realm.
• Authorization Token: A valid JWT token with necessary permissions.

Generating an Authorization Token

If you have access to the realm’s private key, you can generate a token using the following command:

astartectl utils gen-jwt all-realm-apis -k <private_key>

Replace <private_key> with your actual private key file. This command will produce a JWT token granting access to all realm APIs.

Managing Devices

Devices are physical or virtual entities that communicate with Astarte. The Devices section allows users to register, monitor, and interact with devices.

Registering a New Device

To register a new device:

1. Navigate to Devices.
2. Click Register New Device.
3. Enter a unique device identifier (usually a UUID or MAC address).
4. Assign interfaces and initial configurations.
5. Click Register.
6. The device will now appear in the device list with its connection status.

Viewing Device Details

Once a device is registered, you can access its details:

1. Click on a device from the Devices list.
2. The Device Overview page will display:
   • Connection Status: Online, offline, or error states.
   • Last Seen Timestamp: When the device last communicated with Astarte.
   • Interfaces Used: A list of assigned interfaces.
   • Real-time Data Streams: Live updates of device telemetry.
3. You can also trigger manual updates or send control commands to the device.

Removing a Device

To remove a device from the realm:

1. Open the Devices section.
2. Select the device to be removed.
3. Click Delete Device.
4. Confirm the action. The device will be permanently unregistered.

Working with Interfaces

Interfaces define how data is structured and transmitted between devices and Astarte. They serve as the communication model for devices, ensuring consistent data exchange.

Creating an Interface

1. Navigate to Interfaces.
2. Click Create New Interface.
3. Provide the following details:
   • Interface Name: A unique name for the interface.
   • Version: Interface version number (e.g., 1.0).
   • Type: Properties, data streams, or server-owned data.
   • Mappings: Define the data structure, including paths, types, and frequency.
4. Save and deploy the interface.
5. Assign the interface to relevant devices.

Updating an Interface

1. Select an existing interface.
2. Edit its schema or mappings.
3. Save the changes and redeploy.

Deleting an Interface

1. Go to the Interfaces section.
2. Click on the interface to remove.
3. Select Delete Interface.
4. Confirm the action. The interface will be removed.

Setting Up Triggers

Triggers allow automation based on device events. They enable real-time responses to conditions such as device connectivity changes, data threshold breaches, or specific messages received.

Creating a Trigger

1. Navigate to Triggers.
2. Click Create New Trigger.
3. Provide a name and description.
4. Define the event type:
   • Device State Change: Trigger an action when a device connects or disconnects.
   • Data Threshold Exceeded: Monitor and respond to specific data values.
   • Custom Event: Define a custom rule based on interfaces and properties.
5. Set up the action:
   • Send a Notification: Notify administrators or external systems.
   • Store Data in an External System: Forward data to a database or analytics platform.
   • Trigger Another Event: Chain triggers for complex automation.
6. Save and activate the trigger.

Managing Triggers

• Enable or Disable Triggers: Activate or deactivate triggers as needed.
• Edit Trigger Conditions: Modify trigger parameters to refine automation rules.
• Delete Triggers: Remove unused triggers from the system.

Viewing Data Streams

The Streams & Data section of the Astarte Dashboard allows users to monitor real-time data from connected devices. It provides visibility into telemetry, event logs, and historical data.

Monitoring Live Data

1. Navigate to Streams & Data.
2. Select a device or interface.
3. View data logs and real-time telemetry updates.
4. Filter data based on time range, interface, or event type.

Exporting Data

1. Select a data stream.
2. Choose an export format (CSV, JSON, etc.).
3. Download the data for offline analysis.

Data Visualization

• The dashboard provides charts and graphs for a quick overview of trends.
• Users can configure custom views to focus on specific metrics.
• Data retention policies ensure logs are stored based on system configurations.

Conclusion

The Astarte Dashboard provides a powerful interface for managing IoT ecosystems. By leveraging its features, users can efficiently oversee device connectivity, data exchange, and system automation.