1. Tutorials
  2. Launching a Distribution

Launching a Distribution

Learn how to launch a Distribution based on one of your M2X Devices using the M2X Developer Portal.

Tutorial Outline

What is a Distribution?

A Distribution represents a group of devices that inherit the attributes of the original device that the Distribution was based on when created. Devices in a distribution retain the attributes of the original Device such as Streams, Triggers and Tags.


Distributions are ideal for when you’re ready to move towards launching and distributing a product that is based on an M2X Device that you’ve prototyped and configured to your product’s specifications.


Note: Distributions are an advanced feature accessible in upgraded M2X accounts. If you’re using an M2X Developer account you’ll need to upgrade your account in order to access the Distributions feature.

Distribution Attributes

Distribution ID

The Distribution ID is used when making requests to the Distribution API to access or modify this Distribution.


Distribution API Key

The Distribution API Key is used to authenticate requests to the Device API, and provides access to all Devices in the Distribution.


Devices

Devices in a distribution retain the attributes of the Distribution such as Triggers, Streams and Tags. Newly created Distributions do not have any associated Devices, until added via the API using the Device API and the Distributions API key, or via the M2X Developer Portal.

It is important to note that once you’ve added a Device to a Distribution, you will no longer be able to modify the Distribution’s Stream and Trigger configuration.


Streams

A Distribution’s Streams can be viewed and modified via the Streams Tab in the Distribution’s detail page in the M2X Developer Portal. Any Devices added to a Distribution will inherit the Stream configuration of the Distribution. As noted previously, once a Device has been added to a Distribution you will no longer be able to modify the Distribution’s Stream configuration.


Triggers

A Distribution’s Triggers can be viewed and modified via the Triggers Tab in the Distribution’s detail page in the M2X Developer Portal. Any Devices added to a Distribution will inherit the Trigger configuration of the Distribution. As noted previously, once a Device has been added to a Distribution you will no longer be able to modify the Distribution’s Trigger configuration.

How to Launch a Distribution

  1. Navigate to the Device dashboard and select the device you’d like the Distribution to be based on. Note: Devices that are in the Disabled state cannot be distributed. If your device is Disabled change it’s status to Enabled before proceeding with distribution.
  2. Select Distribute to create a Distribution based on this device.
  3. Enter a Name and optional Description for the distribution.
  4. Choose the Distributions visibility. Access to Private Distributions is controlled by API keys, whereas data associated with Public Distributions is publicly accessible.
  5. Select Add Distribution to create the Distribution.