mirror of
https://github.com/balena-io/balena-cli.git
synced 2024-12-19 13:47:52 +00:00
469 lines
13 KiB
CoffeeScript
469 lines
13 KiB
CoffeeScript
###
|
|
Copyright 2016-2017 Balena
|
|
|
|
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.
|
|
###
|
|
|
|
commandOptions = require('./command-options')
|
|
_ = require('lodash')
|
|
{ normalizeUuidProp } = require('../utils/normalization')
|
|
|
|
expandForAppName = {
|
|
$expand: belongs_to__application: $select: 'app_name'
|
|
}
|
|
|
|
exports.list =
|
|
signature: 'devices'
|
|
description: 'list all devices'
|
|
help: '''
|
|
Use this command to list all devices that belong to you.
|
|
|
|
You can filter the devices by application by using the `--application` option.
|
|
|
|
Examples:
|
|
|
|
$ balena devices
|
|
$ balena devices --application MyApp
|
|
$ balena devices --app MyApp
|
|
$ balena devices -a MyApp
|
|
'''
|
|
options: [ commandOptions.optionalApplication ]
|
|
permission: 'user'
|
|
primary: true
|
|
action: (params, options, done) ->
|
|
Promise = require('bluebird')
|
|
balena = require('balena-sdk').fromSharedOptions()
|
|
visuals = require('resin-cli-visuals')
|
|
|
|
Promise.try ->
|
|
if options.application?
|
|
return balena.models.device.getAllByApplication(options.application, expandForAppName)
|
|
return balena.models.device.getAll(expandForAppName)
|
|
|
|
.tap (devices) ->
|
|
devices = _.map devices, (device) ->
|
|
device.dashboard_url = balena.models.device.getDashboardUrl(device.uuid)
|
|
device.application_name = device.belongs_to__application[0].app_name
|
|
device.uuid = device.uuid.slice(0, 7)
|
|
return device
|
|
|
|
console.log visuals.table.horizontal devices, [
|
|
'id'
|
|
'uuid'
|
|
'device_name'
|
|
'device_type'
|
|
'application_name'
|
|
'status'
|
|
'is_online'
|
|
'supervisor_version'
|
|
'os_version'
|
|
'dashboard_url'
|
|
]
|
|
.nodeify(done)
|
|
|
|
exports.info =
|
|
signature: 'device <uuid>'
|
|
description: 'list a single device'
|
|
help: '''
|
|
Use this command to show information about a single device.
|
|
|
|
Examples:
|
|
|
|
$ balena device 7cf02a6
|
|
'''
|
|
permission: 'user'
|
|
primary: true
|
|
action: (params, options, done) ->
|
|
normalizeUuidProp(params)
|
|
balena = require('balena-sdk').fromSharedOptions()
|
|
visuals = require('resin-cli-visuals')
|
|
|
|
balena.models.device.get(params.uuid, expandForAppName)
|
|
.then (device) ->
|
|
balena.models.device.getStatus(device).then (status) ->
|
|
device.status = status
|
|
device.dashboard_url = balena.models.device.getDashboardUrl(device.uuid)
|
|
device.application_name = device.belongs_to__application[0].app_name
|
|
device.commit = device.is_on__commit
|
|
|
|
console.log visuals.table.vertical device, [
|
|
"$#{device.device_name}$"
|
|
'id'
|
|
'device_type'
|
|
'status'
|
|
'is_online'
|
|
'ip_address'
|
|
'application_name'
|
|
'last_seen'
|
|
'uuid'
|
|
'commit'
|
|
'supervisor_version'
|
|
'is_web_accessible'
|
|
'note'
|
|
'os_version'
|
|
'dashboard_url'
|
|
]
|
|
.nodeify(done)
|
|
|
|
exports.supported =
|
|
signature: 'devices supported'
|
|
description: 'list all supported devices'
|
|
help: '''
|
|
Use this command to get the list of all supported devices
|
|
|
|
Examples:
|
|
|
|
$ balena devices supported
|
|
'''
|
|
action: (params, options, done) ->
|
|
balena = require('balena-sdk').fromSharedOptions()
|
|
visuals = require('resin-cli-visuals')
|
|
|
|
balena.models.config.getDeviceTypes().then (deviceTypes) ->
|
|
fields = ['slug', 'name']
|
|
console.log visuals.table.horizontal(_.sortBy(deviceTypes, fields), fields)
|
|
.nodeify(done)
|
|
|
|
exports.register =
|
|
signature: 'device register <application>'
|
|
description: 'register a device'
|
|
help: '''
|
|
Use this command to register a device to an application.
|
|
|
|
Examples:
|
|
|
|
$ balena device register MyApp
|
|
$ balena device register MyApp --uuid <uuid>
|
|
'''
|
|
permission: 'user'
|
|
options: [
|
|
{
|
|
signature: 'uuid'
|
|
description: 'custom uuid'
|
|
parameter: 'uuid'
|
|
alias: 'u'
|
|
}
|
|
]
|
|
action: (params, options, done) ->
|
|
Promise = require('bluebird')
|
|
balena = require('balena-sdk').fromSharedOptions()
|
|
|
|
Promise.join(
|
|
balena.models.application.get(params.application)
|
|
options.uuid ? balena.models.device.generateUniqueKey()
|
|
(application, uuid) ->
|
|
console.info("Registering to #{application.app_name}: #{uuid}")
|
|
return balena.models.device.register(application.id, uuid)
|
|
)
|
|
.get('uuid')
|
|
.nodeify(done)
|
|
|
|
exports.remove =
|
|
signature: 'device rm <uuid>'
|
|
description: 'remove a device'
|
|
help: '''
|
|
Use this command to remove a device from balena.
|
|
|
|
Notice this command asks for confirmation interactively.
|
|
You can avoid this by passing the `--yes` boolean option.
|
|
|
|
Examples:
|
|
|
|
$ balena device rm 7cf02a6
|
|
$ balena device rm 7cf02a6 --yes
|
|
'''
|
|
options: [ commandOptions.yes ]
|
|
permission: 'user'
|
|
action: (params, options, done) ->
|
|
normalizeUuidProp(params)
|
|
balena = require('balena-sdk').fromSharedOptions()
|
|
patterns = require('../utils/patterns')
|
|
|
|
patterns.confirm(options.yes, 'Are you sure you want to delete the device?').then ->
|
|
balena.models.device.remove(params.uuid)
|
|
.nodeify(done)
|
|
|
|
exports.identify =
|
|
signature: 'device identify <uuid>'
|
|
description: 'identify a device with a UUID'
|
|
help: '''
|
|
Use this command to identify a device.
|
|
|
|
In the Raspberry Pi, the ACT led is blinked several times.
|
|
|
|
Examples:
|
|
|
|
$ balena device identify 23c73a1
|
|
'''
|
|
permission: 'user'
|
|
action: (params, options, done) ->
|
|
normalizeUuidProp(params)
|
|
balena = require('balena-sdk').fromSharedOptions()
|
|
balena.models.device.identify(params.uuid).nodeify(done)
|
|
|
|
exports.reboot =
|
|
signature: 'device reboot <uuid>'
|
|
description: 'restart a device'
|
|
help: '''
|
|
Use this command to remotely reboot a device
|
|
|
|
Examples:
|
|
|
|
$ balena device reboot 23c73a1
|
|
'''
|
|
options: [ commandOptions.forceUpdateLock ]
|
|
permission: 'user'
|
|
action: (params, options, done) ->
|
|
normalizeUuidProp(params)
|
|
balena = require('balena-sdk').fromSharedOptions()
|
|
balena.models.device.reboot(params.uuid, options).nodeify(done)
|
|
|
|
exports.shutdown =
|
|
signature: 'device shutdown <uuid>'
|
|
description: 'shutdown a device'
|
|
help: '''
|
|
Use this command to remotely shutdown a device
|
|
|
|
Examples:
|
|
|
|
$ balena device shutdown 23c73a1
|
|
'''
|
|
options: [ commandOptions.forceUpdateLock ]
|
|
permission: 'user'
|
|
action: (params, options, done) ->
|
|
normalizeUuidProp(params)
|
|
balena = require('balena-sdk').fromSharedOptions()
|
|
balena.models.device.shutdown(params.uuid, options).nodeify(done)
|
|
|
|
exports.enableDeviceUrl =
|
|
signature: 'device public-url enable <uuid>'
|
|
description: 'enable public URL for a device'
|
|
help: '''
|
|
Use this command to enable public URL for a device
|
|
|
|
Examples:
|
|
|
|
$ balena device public-url enable 23c73a1
|
|
'''
|
|
permission: 'user'
|
|
action: (params, options, done) ->
|
|
normalizeUuidProp(params)
|
|
balena = require('balena-sdk').fromSharedOptions()
|
|
balena.models.device.enableDeviceUrl(params.uuid).nodeify(done)
|
|
|
|
exports.disableDeviceUrl =
|
|
signature: 'device public-url disable <uuid>'
|
|
description: 'disable public URL for a device'
|
|
help: '''
|
|
Use this command to disable public URL for a device
|
|
|
|
Examples:
|
|
|
|
$ balena device public-url disable 23c73a1
|
|
'''
|
|
permission: 'user'
|
|
action: (params, options, done) ->
|
|
normalizeUuidProp(params)
|
|
balena = require('balena-sdk').fromSharedOptions()
|
|
balena.models.device.disableDeviceUrl(params.uuid).nodeify(done)
|
|
|
|
exports.getDeviceUrl =
|
|
signature: 'device public-url <uuid>'
|
|
description: 'gets the public URL of a device'
|
|
help: '''
|
|
Use this command to get the public URL of a device
|
|
|
|
Examples:
|
|
|
|
$ balena device public-url 23c73a1
|
|
'''
|
|
permission: 'user'
|
|
action: (params, options, done) ->
|
|
normalizeUuidProp(params)
|
|
balena = require('balena-sdk').fromSharedOptions()
|
|
balena.models.device.getDeviceUrl(params.uuid).then (url) ->
|
|
console.log(url)
|
|
.nodeify(done)
|
|
|
|
exports.hasDeviceUrl =
|
|
signature: 'device public-url status <uuid>'
|
|
description: 'Returns true if public URL is enabled for a device'
|
|
help: '''
|
|
Use this command to determine if public URL is enabled for a device
|
|
|
|
Examples:
|
|
|
|
$ balena device public-url status 23c73a1
|
|
'''
|
|
permission: 'user'
|
|
action: (params, options, done) ->
|
|
normalizeUuidProp(params)
|
|
balena = require('balena-sdk').fromSharedOptions()
|
|
balena.models.device.hasDeviceUrl(params.uuid).then (hasDeviceUrl) ->
|
|
console.log(hasDeviceUrl)
|
|
.nodeify(done)
|
|
|
|
exports.rename =
|
|
signature: 'device rename <uuid> [newName]'
|
|
description: 'rename a balena device'
|
|
help: '''
|
|
Use this command to rename a device.
|
|
|
|
If you omit the name, you'll get asked for it interactively.
|
|
|
|
Examples:
|
|
|
|
$ balena device rename 7cf02a6
|
|
$ balena device rename 7cf02a6 MyPi
|
|
'''
|
|
permission: 'user'
|
|
action: (params, options, done) ->
|
|
normalizeUuidProp(params)
|
|
Promise = require('bluebird')
|
|
balena = require('balena-sdk').fromSharedOptions()
|
|
form = require('resin-cli-form')
|
|
|
|
Promise.try ->
|
|
return params.newName if not _.isEmpty(params.newName)
|
|
|
|
form.ask
|
|
message: 'How do you want to name this device?'
|
|
type: 'input'
|
|
|
|
.then(_.partial(balena.models.device.rename, params.uuid))
|
|
.nodeify(done)
|
|
|
|
exports.move =
|
|
signature: 'device move <uuid>'
|
|
description: 'move a device to another application'
|
|
help: '''
|
|
Use this command to move a device to another application you own.
|
|
|
|
If you omit the application, you'll get asked for it interactively.
|
|
|
|
Examples:
|
|
|
|
$ balena device move 7cf02a6
|
|
$ balena device move 7cf02a6 --application MyNewApp
|
|
'''
|
|
permission: 'user'
|
|
options: [ commandOptions.optionalApplication ]
|
|
action: (params, options, done) ->
|
|
normalizeUuidProp(params)
|
|
balena = require('balena-sdk').fromSharedOptions()
|
|
patterns = require('../utils/patterns')
|
|
|
|
balena.models.device.get(params.uuid, expandForAppName).then (device) ->
|
|
return options.application if options.application
|
|
|
|
return Promise.all([
|
|
balena.models.device.getManifestBySlug(device.device_type)
|
|
balena.models.config.getDeviceTypes()
|
|
]).then ([deviceDeviceType, deviceTypes]) ->
|
|
compatibleDeviceTypes = deviceTypes.filter (dt) ->
|
|
balena.models.os.isArchitectureCompatibleWith(deviceDeviceType.arch, dt.arch) &&
|
|
!!dt.isDependent == !!deviceDeviceType.isDependent &&
|
|
dt.state != 'DISCONTINUED'
|
|
|
|
return patterns.selectApplication (application) ->
|
|
return _.every [
|
|
_.some(compatibleDeviceTypes, (dt) -> dt.slug == application.device_type)
|
|
device.belongs_to__application[0].app_name isnt application.app_name
|
|
]
|
|
.tap (application) ->
|
|
return balena.models.device.move(params.uuid, application)
|
|
.then (application) ->
|
|
console.info("#{params.uuid} was moved to #{application}")
|
|
.nodeify(done)
|
|
|
|
exports.init =
|
|
signature: 'device init'
|
|
description: 'initialise a device with balenaOS'
|
|
help: '''
|
|
Use this command to download the OS image of a certain application and write it to an SD Card.
|
|
|
|
Notice this command may ask for confirmation interactively.
|
|
You can avoid this by passing the `--yes` boolean option.
|
|
|
|
Examples:
|
|
|
|
$ balena device init
|
|
$ balena device init --application MyApp
|
|
'''
|
|
options: [
|
|
commandOptions.optionalApplication
|
|
commandOptions.yes
|
|
commandOptions.advancedConfig
|
|
_.assign({}, commandOptions.osVersionOrSemver, { signature: 'os-version', parameter: 'os-version' })
|
|
commandOptions.drive
|
|
{
|
|
signature: 'config'
|
|
description: 'path to the config JSON file, see `balena os build-config`'
|
|
parameter: 'config'
|
|
}
|
|
]
|
|
permission: 'user'
|
|
action: (params, options, done) ->
|
|
Promise = require('bluebird')
|
|
rimraf = Promise.promisify(require('rimraf'))
|
|
tmp = require('tmp')
|
|
tmpNameAsync = Promise.promisify(tmp.tmpName)
|
|
tmp.setGracefulCleanup()
|
|
|
|
balena = require('balena-sdk').fromSharedOptions()
|
|
patterns = require('../utils/patterns')
|
|
{ runCommand } = require('../utils/helpers')
|
|
|
|
Promise.try ->
|
|
return options.application if options.application?
|
|
return patterns.selectApplication()
|
|
.then(balena.models.application.get)
|
|
.then (application) ->
|
|
|
|
download = ->
|
|
tmpNameAsync().then (tempPath) ->
|
|
osVersion = options['os-version'] or 'default'
|
|
runCommand("os download #{application.device_type} --output '#{tempPath}' --version #{osVersion}")
|
|
.disposer (tempPath) ->
|
|
return rimraf(tempPath)
|
|
|
|
Promise.using download(), (tempPath) ->
|
|
runCommand("device register #{application.app_name}")
|
|
.then(balena.models.device.get)
|
|
.tap (device) ->
|
|
configureCommand = "os configure '#{tempPath}' --device #{device.uuid}"
|
|
if options.config
|
|
configureCommand += " --config '#{options.config}'"
|
|
else if options.advanced
|
|
configureCommand += ' --advanced'
|
|
runCommand(configureCommand)
|
|
.then ->
|
|
osInitCommand = "os initialize '#{tempPath}' --type #{application.device_type}"
|
|
if options.yes
|
|
osInitCommand += ' --yes'
|
|
if options.drive
|
|
osInitCommand += " --drive #{options.drive}"
|
|
runCommand(osInitCommand)
|
|
# Make sure the device resource is removed if there is an
|
|
# error when configuring or initializing a device image
|
|
.catch (error) ->
|
|
balena.models.device.remove(device.uuid).finally ->
|
|
throw error
|
|
.then (device) ->
|
|
console.log('Done')
|
|
return device.uuid
|
|
|
|
.nodeify(done)
|
|
|
|
exports.osUpdate = require('./device_ts').osUpdate
|