Mason Docs

Mason Guides

A series of guides that will help you navigate the Mason Platform.

If you would like a general overview of the Mason Platform, visit our Getting started guide!

Platform Lifecycle

(external link)

Set up your Platform account Set up your Devkit Manage Projects Manage Groups Factory Reset Refurbish your Device

Developer Tools

(external link)

Install Mason CLI ADB Logging Broadcast API Install Framework SDK Framework SDK - example Install Android SDK

All guides

(Sorted alphabetically)

Build and deploy your custom Mason OS to your devices

Part 4 of our 'Manage Projects' series, learn how to deploy a Mason OS Project config to a device group

CI/CD Guide

Guide to integrating Mason into a CI/CD pipeline

Clear your Project configuration

Follow this guide to learn how to 'reset' the custom Mason OS configuration on your device

Configure the Mason CLI with an API Key

Some commands in the Mason CLI require a permissioned API Key. This guide will show you how to supply an API key to the Mason CLI.

Create a Broadcast

Broadcasts are a way for an Android application to receive information from an outside source (such as your own backend server or CI/CD system). The Mason platform provides out-of-the-box support for sending broadcasts through the Mason API.

Create a group

Part 2 in our series 'Managing groups', learn how to create new device groups in the Mason Platform

Create a Mason Project

Part 2 of the 'Manage Projects' series, learn how to create a new Project in the Mason Platform

Create a Platform API key

This guide will walk you through creating a scoped API key for use across the Mason Platform

Create your custom OS

Part 3 of our 'Manage Projects' series, learn about Mason OS Project configurations

Create your Platform account

This guide walks you through setting up your Platform account

Demo X-Ray

This guide will provide examples of how to use X-Ray to remotely debug

Demo X-Ray (For devices running Mason OS 6.0.5 and lower)

This guide will provide examples of how to use X-Ray to remotely debug

How To Use ADB to Collect Logs From Mason Devices

Mason devices work with ADB, this guide will walk you through setting up ADB and using logcat to collect a batch of logs off a device you have physical access to

Installing the Mason Android SDK

Get up and running in 10 minutes

Installing the Mason CLI

Get up and running with our Platform CLI in 2 minutes or less!

Installing the Mason CLI (For Mason CLI versions less than 2.0)

Get up and running with our Platform CLI in 2 minutes or less!

Installing the Mason Framework SDK

Get up and running in 10 minutes

Learn about Device Groups in the Mason Platform

Part 1 of our 'Manage groups' series

Learn about Projects in the Mason Platform

Part 1 of the 'Manage Projects' series

Mason Connectivity Guide

Guide to cellular connectivity on Mason Devices or 3rd party IoT devices

Moving Devices between Groups

Part 3 in our 'Manage groups' series, learn how to move your devices between groups

Performing a Factory data reset on your device

Performing a Factory Reset on a Mason device deletes the app-specific data and settings on the device, preserving the device's deployed Project configuration.

Quickstart Guide

Mason Platform quickstart guide

Set up Autocomplete for the Mason CLI

The Mason CLI provides autocomplete shortcuts, speeding up your development

Setting up a Developer Kit

This guide walks you through setting up your first Mason Developer Kit

Setting up X-Ray

This guide will walk you through setting up X-Ray, so you can start debugging your devices remotely

Setting up X-Ray (For devices running Mason OS 6.0.5 and lower)

This guide will walk you through setting up X-Ray, so you can start debugging your devices remotely

Understanding X-Ray

All about X-Ray!

Unlink your Mason device with your Platform account

This guide will walk you through a refurbish, an action that wipes all data from your Mason device and restores it to its original state, prior to provisioning.

Using the Mason Android SDK

This guide will walk you through how to fetch device metadata using the Mason Android SDK

White-labeling Your Project

This guide will walk your through creating a custom boot and splash image for your project