# TMX Access™ Service Platform 2.6 Quick Start Guide

# 1 Preface

This guide is to help users to add a ThingsMatrix approved device into the ThingsMatrix Access™ Service Platform. Please note: Only custom model devices need to be added manually following instructions below. ThingsMatrix will synchronize purchased default model devices automatically.

# Instruction: Add a custom model device

To add a custom model device, please follow these steps:

  1. Add a custom model if there isn't one
  2. Within the custom model, Add a group if there isn't one
  3. within the group, add a device

# Instruction: Issue configuration to devices within an existing group

To issue configuration to devices within an existing group, please follow these steps:

  1. Add a config template if there isn't one
  2. Apply the config template to the group
  3. After the device connects to the Platform, the configuration will be issued

# Instruction: Apply certificate to devices within an existing group

To apply certificate to devices within an existing group, please follow these steps:

  1. Add a certificate if there isn't one
  2. Apply the certificate to the group

# 2 Add a custom model

  1. After logged in, go to Models via the navigation bar on the left. By clicking the + Add Model button on top right, an Add Model window will pop up.

    createCustomModel_1

  2. Fill in the form, then click the Add button to add a new custom model.

    createCustomModel_2

# 3 Add a group

  1. Select a model. Let's take TMA01 we've just added for an example, or you can select one of ThingsMatrix default models you have purchased. Enter the Group List by clicking the Group tab. By clicking the + Add Group button and an Adding Group form will be displayed on the right side.

    createGroup_1

  2. Fill in the form and then click the Add button to Add a group. The group name must be unique. For how to apply a config template to the group, please go to 5 Add a config template section below. For how to apply a certificate to the group, please go to 6 Add a certificate section below. Notification feature is also supported. A description for the group can be added as well.

    createGroup_2

# 4 Add a custom model device

  1. Go to Devices, click the + Add Device button on the top right side.

    addDevice_1

  2. An Add Device window will pop up, fill in the form and click the Add button to add a new device. For "SIM ICCID" field, users can choose to provide or not provide relevant information because the Platform will automatically collect this information. If the Allow for connection after it has changed checkbox is checked, the Platform is allowed to do additional updates after the SIM information is initially populated, such as replacing the SIM card. If not, the Platform will reject the connection to the device if you replace the SIM card after the information is initially populated. You can also assign a specific alias, add tags and custom attributes to the device.

    addDevice_2

  3. You can see the newly added device in the device list.

    addDevice_3

# 5 Add a config template

ThingsMatrix approved devices may have default configurations. For flexibility, the ThingsMatrix Access™ Service Platform provides you a config template which can be applied to device groups. For example, you can edit the reporting interval of the device based on requirements. Then you can apply the config template to groups.

  • Default models purchased from ThingsMatrix
  1. Go to Models, select the default model that you want to add a template for, for example, TMX07. Then enter the Config Template tab and click the + Add Config Template button.

    image-20210326202709184

  2. An Add Config Template window will pop up, fill in the form and click the Add button to add a config template. The image below shows a very simple config template on periodic mode, in which the parameter of "Report Interval" is set to be 60 minutes. Please refer to 8.18 Adding new Templates section in ThingsMatrix Access™ Service Platform 2.6 User Guide for further information on the config template.

    image-20210326203007618

  3. After you add a config template, you can see it in the config template list of the device model.

    image-20210326203111419

  4. Then you can apply the config template to the device group that you want. Enter Group tab, click the desired group card, select the config template we've just added, for example, sampleConfig1. After that, click the Save button to apply the changes. All the devices in the group will apply the specific config template.

    image-20210326203133038

  • Custom models added by users
  1. Go to Models, select the custom model that you want to add a template for, for example, sampleModel. Then enter the Config Template tab and click the + Add Config Template button.

    image-20210326203850063

  2. An Add Config Template window will pop up, please update a JSON file to apply the config template. Please refer to 8.18 Adding new Templates in ThingsMatrix Access™ Service Platform 2.6 User Guide for further information on the config template.

    image-20210326203950165

  3. After you upload a config template, you can see it in the config template list of the device model.

    image-20210326204009143

  4. Then you can apply the config template to the device group that you want. Enter Group tab, click the desired group card, select the config template we've just added, for example, sampleModelConfig. After that, click the Save button to apply the changes. All the devices in the group will apply the specific config template.

    image-20210326204120220

# 6 Add a certificate

  1. Go to Certificates and switch to Device Certificate tab. By clicking the + Add Certificate button, an Add Device Certificate window will pop up.

    image-20210326204902959

  2. Fill in the form and then click the Add button to add a certificate.

    image-20210326204943471

  3. After you add a certificate, you can see it in the certificate list.

    image-20210326205021268

  4. Then you can apply the certificate to the device group that you want. Go to Models, select the custom model that you want to apply a certificate for, for example, SampleModel01. Enter Group tab, click the desired group card, select the certificate we've just added, for example, device_cert. After that, click the Save button to apply the changes. All the devices in the group will apply the specific certificate.

    image-20210326205358954

Last updated: 4/23/2021, 5:34:46 PM