balena-cli/src/commands/device/register.ts

The official balena Command Line Interface

/**
 * @license
 * Copyright 2016-2020 Balena Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { Flags, Command } from '@oclif/core';
import * as ca from '../../utils/common-args';
import { getBalenaSdk, stripIndent } from '../../utils/lazy';
import { applicationIdInfo } from '../../utils/messages';

export default class DeviceRegisterCmd extends Command {
	public static description = stripIndent`
		Register a new device.

		Register a new device with a balena fleet.

		If --uuid is not provided, a new UUID will be automatically assigned.

		${applicationIdInfo.split('\n').join('\n\t\t')}
	`;

	public static examples = [
		'$ balena device register MyFleet',
		'$ balena device register MyFleet --uuid <uuid>',
		'$ balena device register myorg/myfleet --uuid <uuid>',
		'$ balena device register myorg/myfleet --uuid <uuid> --deviceType <deviceTypeSlug>',
	];

	public static args = {
		fleet: ca.fleetRequired,
	};

	public static flags = {
		uuid: Flags.string({
			description: 'custom uuid',
			char: 'u',
		}),
		deviceType: Flags.string({
			description:
				"device type slug (run 'balena device-type list' for possible values)",
		}),
	};

	public static authenticated = true;

	public async run() {
		const { args: params, flags: options } =
			await this.parse(DeviceRegisterCmd);

		const { getApplication } = await import('../../utils/sdk');

		const balena = getBalenaSdk();

		const application = await getApplication(balena, params.fleet, {
			$select: ['id', 'slug'],
		});
		const uuid = options.uuid ?? balena.models.device.generateUniqueKey();

		console.info(`Registering to ${application.slug}: ${uuid}`);

		const result = await balena.models.device.register(
			application.id,
			uuid,
			options.deviceType,
		);

		return result.uuid;
	}
}