Getting Started

Getting Started

This tutorial will walk you through connecting a new device and sending your first commands.

Step 1: Network Connection

Before a device can connect to your MQTT broker, it must be connected to a network.

• Ethernet: If an Ethernet cable is plugged in, the device will automatically use DHCP to obtain an IP address. No user interaction is required. For a static IP, navigate to Menu > Ethernet > Advanced Options on the device.
• Wi-Fi: To connect to a wireless network, you must configure it manually from Menu > Wi-Fi on the device.

Step 2: Connect to the MQTT Broker

Once on the network, the device needs to know the address of your MQTT broker.

1. Navigate to Menu > Server > Message Broker on the device.
2. Verify or enter the IP address or domain name of your broker.
3. Ensure the port and TLS/SSL settings match your broker's configuration.

Pro-Tip: We can pre-configure devices with your MQTT broker's address before shipping. This allows your users to skip this step entirely.

Step 3: Your First Commands

With the device connected, you can now send it commands. A typical initial setup sequence involves:

1. Assigning a Company Code: This groups the device with other devices in your organization.
2. Adding a User: This creates a new user profile on the device.
3. Enrolling a PIN: This associates a PIN with the new user for authentication.

Here’s how you’d do it:

1. Set the Company Code

• Topic: <serial-number>/companycode/save (e.g., 0123456789/companycode/save)
• Message:

  {
    "company_code": "your-company-name"
  }
  

2. Add a User

• Topic: <company-code>/<serial-number>/users/save (e.g., your-company-name/0123456789/users/save)
• Message:

  [
    {
      "user_id": "101",
      "user_role": "Admin",
      "name": "Jane Doe",
      "department": "Engineering",
      "pin": "1234",
      "account_enabled": true,
      "has_access": true,
      "has_access_on_holidays": false,
      "schedules_restricted": true
    }
  ]
  

You have now successfully provisioned your first device! From here, you can proceed to add more users, enroll other credentials like fingerprints and faces, and configure device-specific settings.

---