ExternalVendorCode/balena-cli
1
0
Fork 0
mirror of https://github.com/balena-io/balena-cli.git synced 2025-04-07 11:26:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Document resin/device

Browse Source
This commit is contained in:
Juan Cruz Viotti 2014-12-05 14:48:47 -04:00
parent 8c774bace2
commit 98e845a90b
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
lib/resin/device/device.coffee
View File

@ -3,6 +3,17 @@ _ = require('lodash')
# TODO: This should be fetch from the server
DEVICES = require('./device-data.json')
# Get display name for a device
#
# For a list of supported devices, see getSupportedDevices()
#
# @param {String} device device name
# @return {String} device display name or 'Unknown'
#
# @example Get display name
# console.log resin.device.getDisplayName('raspberry-pi') # Raspberry Pi
# console.log resin.device.getDisplayName('rpi') # Raspberry Pi
#
exports.getDisplayName = (device) ->
if _.indexOf(exports.getSupportedDevices(), device) isnt -1
return device
@ -12,9 +23,25 @@ exports.getDisplayName = (device) ->
return key
return 'Unknown'
# Get device slug
#
# @param {String} device device name
# @return {String} device slug or 'unknown'
#
# @example Get device slug
# console.log resin.device.getDeviceSlug('Raspberry Pi') # raspberry-pi
#
exports.getDeviceSlug = (device) ->
displayName = exports.getDisplayName(device)
return DEVICES[displayName]?.slug or 'unknown'
# Get a list of supported devices
#
# @return {Array<String>} a list of all supported devices, by their display names
#
# @example Get all supported devices
# devices = resin.device.getSupportedDevices()
# console.log(devices)
#
exports.getSupportedDevices = ->
return _.keys(DEVICES)