akenza.io
WebsiteAPI DocumentationWhat's newLogin
  • Overview
  • Getting Started
    • Connect a Device
  • Changelog
  • General
    • Applications
    • Organization context
    • Workspace Context
    • Users
      • User Roles
  • Device Management
    • Managing an organization
      • API keys
      • Users (Organization)
        • Add & removing users from your organization
    • Managing a workspace
      • General Settings
        • Device Lifecycle Reports
        • Workspace properties
        • Occupancy settings
        • Device Setup Assistant
      • Custom fields
      • Tags
      • Users (Workspace)
    • Devices
      • Device
      • Device Simulator
      • Bulk actions
      • Bulk import CSV templates
    • Rules
      • Input
      • Logic blocks
        • Comparison
        • Custom Logic
          • Logic Block Scripting
      • Timed Rules
      • Rule Actions
        • Downlink
    • Data Flows
      • Device Connectors
        • Device Security
          • Using Device Credentials
            • Creating Public/Private Key Pairs
            • Using JSON Web Tokens (JWTs)
              • Python
              • Java
        • HTTP
        • MQTT
        • CoAP
        • LoRaWAN
          • Connectivity Management
          • Swisscom LoRaWAN
          • The Things Network
          • Loriot
          • Actility’s ThingPark Wireless
          • EWZ
          • Cibicom
          • Helium
          • ChirpStack
        • NB-IoT
        • mioty
        • Disruptive Technologies
        • VergeSense
        • Spaceti
        • Haltian
      • Device Types
        • Custom Device Types
          • Uplink
          • Downlink
          • Scripting
        • Library
      • Output Connectors
        • Databases
          • akenza DB
          • InfluxDB
          • SQL Databases
        • Streaming
          • Webhook
          • Azure IoT Hub
          • AWS Kinesis
          • Google Cloud Pub/Sub
          • Apache Kafka
        • Notifications
          • E-Mail
          • SMS
          • Microsoft Teams
          • Slack
    • Custom Components
    • Integrations
    • Reference
      • REST API
        • Filtering
        • Querying Device Data
      • WebSocket API
      • Scripting
        • Stateful Operations
        • Utility Functions
      • Payload Templating
  • Reference
  • Dashboard Builder
    • Managing Dashboards
      • Embedding dashboards
    • Components
      • Map
      • Floorplan
  • Device Setup Assistant
    • Device Setup Assistant - Overview
  • Tutorials
    • BI Tools
      • Grafana Data Source Plugin
      • How to build a dashboard with Retool
      • How to analyze data with AWS QuickSight
    • Devices
      • How to integrate the XDK device from Legic via MQTT on akenza
      • How to connect the Disruptive Technologies-cloud on akenza
      • How to send Downlinks to the Kuando Busylight device
      • How to integrate an Arduino device via MQTT on akenza
      • Integrate a MClimate Vicki LoRaWAN Radiator Thermostat on akenza
      • How to integrate an ERS Elsys device with Loriot on akenza
      • How to integrate the IAM Decentlab device with TTN on akenza
      • How to integrate the Seeed SenseCAP T1000 tracker on akenza
      • How to integrate a Swisscom Multisense device on akenza
    • Notifications
      • How to send SMS notifications
      • How to send notifications to Slack
      • How to send notifications to Microsoft Teams
    • Enterprise solutions
      • How to send data to Azure IoT Hub
      • How to send data to the Google Cloud Pub/Sub
      • How to send data to InfluxDB
      • How to send data to AWS Kinesis
      • How to send data to Azure Event Hubs with Apache Kafka
    • IoT Starter Kits
      • How to integrate the IAQ Kit with Actility on akenza
      • How to integrate the CoWork Kit with Actility on akenza
      • How to integrate the Smart Building Kit with Actility on akenza
      • How to integrate the Pepperl+Fuchs Kit with Actility on akenza
  • Support Center
    • FAQ
    • Status Page
    • Service Desk
    • Request a feature
  • Deprecated
    • SIM-Cards
    • Everynet
    • Sigfox
    • How to connect the Yanzi Lifecycle cloud on akenza
Powered by GitBook
On this page

Was this helpful?

  1. Device Setup Assistant

Device Setup Assistant - Overview

PreviousFloorplanNextBI Tools

Last updated 9 months ago

Was this helpful?

Large-scale device onboarding made easy

Configure and deploy your devices faster than ever with the Device Setup Assistant. This tool provides an easy and seamless setup experience, even for IoT beginners. With this tool, you can assign useful Custom Fields and Tags to devices during the installation process. This makes managing your device fleet easier and facilitates integration into third-party applications.

Prerequisites

Before using the Device Setup Assistant, ensure that assets have already been created in your workspace. For setting up multiple devices simultaneously, we recommend using the feature.

The Device Setup Assistant is accessible on both mobile and desktop devices.

Steps to Setup a Device

  1. Scan Device QR Code

    Scan the QR code on the device. The QR code must redirect to the following URL structure:

    https://api.akenza.io/v3/resolve-device?deviceId=0018B20000001122

    Here, 0018B20000001122 represents the Device ID / DevEUI of the asset. As an alternative, you can select your device from the list of added devices.

  2. Device Overview

    Check if the correct device has been selected. If the device has already sent data, you can use the “Last Message Time” to verify if the device is online. Additionally, you can view the signal quality and the current battery level. If the device has been assigned CustomFields or Tags, you can also view them here.

  3. Configure Device

    Add values to your Custom Fields and Tags for your physical asset. This helps in categorizing and managing your devices efficiently.

  4. Complete Setup

    That’s it! Your device is now fully set up and ready to use.

Advanced Setup with CSV Upload

To simplify the setup process even further, you can upload a CSV file with pre-filled Custom Fields, Tags, and Device Names. Follow these guidelines for the CSV file:

  • The field names "tags" and "deviceName" must not be changed.

  • Custom Fields and Tags must be predefined in the Workspace with the exact same names to be utilized by the Device Setup Assistant.

  • Define which Custom Field should be the Primary Field. This field can be selected from a dropdown list in the Device Setup Assistant, and all other fields will be automatically filled based on the uploaded CSV.

Example CSV Structure:

After selecting your device or scanning the QR code, only your primary Field needs to be selected, and all other values will be filled out as defined in the CSV. Save changes to apply them to your device.

Bulk I
mport
421B
Device Setup Assistant Template.csv