## resin : object Welcome to the Resin SDK documentation. This document aims to describe all the functions supported by the SDK, as well as showing examples of their expected usage. If you feel something is missing, not clear or could be improved, please don't hesitate to open an [issue in GitHub](https://github.com/resin-io/resin-sdk/issues/new), we'll be happy to help. **Kind**: global namespace * [resin](#resin) : object * [.interceptors](#resin.interceptors) : Array.<Interceptor> * [.Interceptor](#resin.interceptors.Interceptor) : object * [.request](#resin.request) : Object * [.pine](#resin.pine) : Object * [.errors](#resin.errors) : Object * [.models](#resin.models) : object * [.application](#resin.models.application) : object * [.tags](#resin.models.application.tags) : object * [.getAllByApplication(nameOrId, [options])](#resin.models.application.tags.getAllByApplication) ⇒ Promise * [.getAll([options])](#resin.models.application.tags.getAll) ⇒ Promise * [.set(nameOrId, tagKey, value)](#resin.models.application.tags.set) ⇒ Promise * [.remove(nameOrId, tagKey)](#resin.models.application.tags.remove) ⇒ Promise * [.configVar](#resin.models.application.configVar) : object * [.getAllByApplication(nameOrId, [options])](#resin.models.application.configVar.getAllByApplication) ⇒ Promise * [.get(nameOrId, key)](#resin.models.application.configVar.get) ⇒ Promise * [.set(nameOrId, key, value)](#resin.models.application.configVar.set) ⇒ Promise * [.remove(nameOrId, key)](#resin.models.application.configVar.remove) ⇒ Promise * [.envVar](#resin.models.application.envVar) : object * [.getAllByApplication(nameOrId, [options])](#resin.models.application.envVar.getAllByApplication) ⇒ Promise * [.get(nameOrId, key)](#resin.models.application.envVar.get) ⇒ Promise * [.set(nameOrId, key, value)](#resin.models.application.envVar.set) ⇒ Promise * [.remove(nameOrId, key)](#resin.models.application.envVar.remove) ⇒ Promise * [.getAll([options])](#resin.models.application.getAll) ⇒ Promise * [.get(nameOrId, [options])](#resin.models.application.get) ⇒ Promise * [.getWithDeviceServiceDetails(nameOrId, [options])](#resin.models.application.getWithDeviceServiceDetails) ⇒ Promise * [.getAppByOwner(appName, owner, [options])](#resin.models.application.getAppByOwner) ⇒ Promise * [.has(nameOrId)](#resin.models.application.has) ⇒ Promise * [.hasAny()](#resin.models.application.hasAny) ⇒ Promise * [.create(options)](#resin.models.application.create) ⇒ Promise * [.remove(nameOrId)](#resin.models.application.remove) ⇒ Promise * [.restart(nameOrId)](#resin.models.application.restart) ⇒ Promise * ~~[.generateApiKey(nameOrId)](#resin.models.application.generateApiKey) ⇒ Promise~~ * [.generateProvisioningKey(nameOrId)](#resin.models.application.generateProvisioningKey) ⇒ Promise * [.purge(appId)](#resin.models.application.purge) ⇒ Promise * [.shutdown(appId, [options])](#resin.models.application.shutdown) ⇒ Promise * [.reboot(appId, [options])](#resin.models.application.reboot) ⇒ Promise * [.enableDeviceUrls(nameOrId)](#resin.models.application.enableDeviceUrls) ⇒ Promise * [.disableDeviceUrls(nameOrId)](#resin.models.application.disableDeviceUrls) ⇒ Promise * [.grantSupportAccess(nameOrId, expiryTimestamp)](#resin.models.application.grantSupportAccess) ⇒ Promise * [.revokeSupportAccess(nameOrId)](#resin.models.application.revokeSupportAccess) ⇒ Promise * [.device](#resin.models.device) : object * [.tags](#resin.models.device.tags) : object * [.getAllByApplication(nameOrId, [options])](#resin.models.device.tags.getAllByApplication) ⇒ Promise * [.getAllByDevice(uuidOrId, [options])](#resin.models.device.tags.getAllByDevice) ⇒ Promise * [.getAll([options])](#resin.models.device.tags.getAll) ⇒ Promise * [.set(uuidOrId, tagKey, value)](#resin.models.device.tags.set) ⇒ Promise * [.remove(uuidOrId, tagKey)](#resin.models.device.tags.remove) ⇒ Promise * [.configVar](#resin.models.device.configVar) : object * [.getAllByDevice(uuidOrId, [options])](#resin.models.device.configVar.getAllByDevice) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.device.configVar.getAllByApplication) ⇒ Promise * [.get(uuidOrId, key)](#resin.models.device.configVar.get) ⇒ Promise * [.set(uuidOrId, key, value)](#resin.models.device.configVar.set) ⇒ Promise * [.remove(uuidOrId, key)](#resin.models.device.configVar.remove) ⇒ Promise * [.envVar](#resin.models.device.envVar) : object * [.getAllByDevice(uuidOrId, [options])](#resin.models.device.envVar.getAllByDevice) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.device.envVar.getAllByApplication) ⇒ Promise * [.get(uuidOrId, key)](#resin.models.device.envVar.get) ⇒ Promise * [.set(uuidOrId, key, value)](#resin.models.device.envVar.set) ⇒ Promise * [.remove(uuidOrId, key)](#resin.models.device.envVar.remove) ⇒ Promise * [.serviceVar](#resin.models.device.serviceVar) : object * [.getAllByDevice(uuidOrId, [options])](#resin.models.device.serviceVar.getAllByDevice) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.device.serviceVar.getAllByApplication) ⇒ Promise * [.get(uuidOrId, id, key)](#resin.models.device.serviceVar.get) ⇒ Promise * [.set(uuidOrId, id, key, value)](#resin.models.device.serviceVar.set) ⇒ Promise * [.remove(uuidOrId, id, key)](#resin.models.device.serviceVar.remove) ⇒ Promise * [.getDashboardUrl(uuid)](#resin.models.device.getDashboardUrl) ⇒ String * [.getAll([options])](#resin.models.device.getAll) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.device.getAllByApplication) ⇒ Promise * [.getAllByParentDevice(parentUuidOrId, [options])](#resin.models.device.getAllByParentDevice) ⇒ Promise * [.get(uuidOrId, [options])](#resin.models.device.get) ⇒ Promise * [.getWithServiceDetails(uuidOrId, [options])](#resin.models.device.getWithServiceDetails) ⇒ Promise * [.getByName(name)](#resin.models.device.getByName) ⇒ Promise * [.getName(uuidOrId)](#resin.models.device.getName) ⇒ Promise * [.getApplicationName(uuidOrId)](#resin.models.device.getApplicationName) ⇒ Promise * ~~[.getApplicationInfo(uuidOrId)](#resin.models.device.getApplicationInfo) ⇒ Promise~~ * [.has(uuidOrId)](#resin.models.device.has) ⇒ Promise * [.isOnline(uuidOrId)](#resin.models.device.isOnline) ⇒ Promise * [.getLocalIPAddresses(uuidOrId)](#resin.models.device.getLocalIPAddresses) ⇒ Promise * [.remove(uuidOrId)](#resin.models.device.remove) ⇒ Promise * [.identify(uuidOrId)](#resin.models.device.identify) ⇒ Promise * [.rename(uuidOrId, newName)](#resin.models.device.rename) ⇒ Promise * [.note(uuidOrId, note)](#resin.models.device.note) ⇒ Promise * [.setCustomLocation(uuidOrId, location)](#resin.models.device.setCustomLocation) ⇒ Promise * [.unsetCustomLocation(uuidOrId)](#resin.models.device.unsetCustomLocation) ⇒ Promise * [.move(uuidOrId, applicationNameOrId)](#resin.models.device.move) ⇒ Promise * ~~[.startApplication(uuidOrId)](#resin.models.device.startApplication) ⇒ Promise~~ * ~~[.stopApplication(uuidOrId)](#resin.models.device.stopApplication) ⇒ Promise~~ * [.restartApplication(uuidOrId)](#resin.models.device.restartApplication) ⇒ Promise * [.startService(uuidOrId, imageId)](#resin.models.device.startService) ⇒ Promise * [.stopService(uuidOrId, imageId)](#resin.models.device.stopService) ⇒ Promise * [.restartService(uuidOrId, imageId)](#resin.models.device.restartService) ⇒ Promise * [.reboot(uuidOrId, [options])](#resin.models.device.reboot) ⇒ Promise * [.shutdown(uuidOrId, [options])](#resin.models.device.shutdown) ⇒ Promise * [.purge(uuidOrId)](#resin.models.device.purge) ⇒ Promise * [.update(uuidOrId, [options])](#resin.models.device.update) ⇒ Promise * [.getDisplayName(deviceTypeSlug)](#resin.models.device.getDisplayName) ⇒ Promise * [.getDeviceSlug(deviceTypeName)](#resin.models.device.getDeviceSlug) ⇒ Promise * [.getSupportedDeviceTypes()](#resin.models.device.getSupportedDeviceTypes) ⇒ Promise * [.getManifestBySlug(slug)](#resin.models.device.getManifestBySlug) ⇒ Promise * [.getManifestByApplication(nameOrId)](#resin.models.device.getManifestByApplication) ⇒ Promise * [.generateUniqueKey()](#resin.models.device.generateUniqueKey) ⇒ String * [.register(applicationNameOrId, [uuid])](#resin.models.device.register) ⇒ Promise * [.generateDeviceKey(uuidOrId)](#resin.models.device.generateDeviceKey) ⇒ Promise * [.hasDeviceUrl(uuidOrId)](#resin.models.device.hasDeviceUrl) ⇒ Promise * [.getDeviceUrl(uuidOrId)](#resin.models.device.getDeviceUrl) ⇒ Promise * [.enableDeviceUrl(uuidOrId)](#resin.models.device.enableDeviceUrl) ⇒ Promise * [.disableDeviceUrl(uuidOrId)](#resin.models.device.disableDeviceUrl) ⇒ Promise * [.ping(uuidOrId)](#resin.models.device.ping) ⇒ Promise * [.getStatus(device)](#resin.models.device.getStatus) ⇒ Promise * [.grantSupportAccess(uuidOrId, expiryTimestamp)](#resin.models.device.grantSupportAccess) ⇒ Promise * [.revokeSupportAccess(uuidOrId)](#resin.models.device.revokeSupportAccess) ⇒ Promise * [.lastOnline(device)](#resin.models.device.lastOnline) ⇒ String * [.apiKey](#resin.models.apiKey) : object * [.create(name, [description])](#resin.models.apiKey.create) ⇒ Promise * [.getAll([options])](#resin.models.apiKey.getAll) ⇒ Promise * [.update(id, apiKeyInfo)](#resin.models.apiKey.update) ⇒ Promise * [.revoke(id)](#resin.models.apiKey.revoke) ⇒ Promise * [.key](#resin.models.key) : object * [.getAll([options])](#resin.models.key.getAll) ⇒ Promise * [.get(id)](#resin.models.key.get) ⇒ Promise * [.remove(id)](#resin.models.key.remove) ⇒ Promise * [.create(title, key)](#resin.models.key.create) ⇒ Promise * [.os](#resin.models.os) : object * [.getDownloadSize(deviceType, [version])](#resin.models.os.getDownloadSize) ⇒ Promise * [.getSupportedVersions(deviceType)](#resin.models.os.getSupportedVersions) ⇒ Promise * [.getMaxSatisfyingVersion(deviceType, versionOrRange)](#resin.models.os.getMaxSatisfyingVersion) ⇒ Promise * [.getLastModified(deviceType, [version])](#resin.models.os.getLastModified) ⇒ Promise * [.download(deviceType, [version])](#resin.models.os.download) ⇒ Promise * [.getConfig(nameOrId, options)](#resin.models.os.getConfig) ⇒ Promise * [.config](#resin.models.config) : object * [.getAll()](#resin.models.config.getAll) ⇒ Promise * [.getDeviceTypes()](#resin.models.config.getDeviceTypes) ⇒ Promise * [.getDeviceOptions(deviceType)](#resin.models.config.getDeviceOptions) ⇒ Promise * [.release](#resin.models.release) : object * [.tags](#resin.models.release.tags) : object * [.getAllByApplication(nameOrId, [options])](#resin.models.release.tags.getAllByApplication) ⇒ Promise * [.getAllByRelease(id, [options])](#resin.models.release.tags.getAllByRelease) ⇒ Promise * [.getAll([options])](#resin.models.release.tags.getAll) ⇒ Promise * [.set(releaseId, tagKey, value)](#resin.models.release.tags.set) ⇒ Promise * [.remove(releaseId, tagKey)](#resin.models.release.tags.remove) ⇒ Promise * [.get(id, [options])](#resin.models.release.get) ⇒ Promise * [.getWithImageDetails(id, [options])](#resin.models.release.getWithImageDetails) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.release.getAllByApplication) ⇒ Promise * [.service](#resin.models.service) : object * [.var](#resin.models.service.var) : object * [.getAllByService(id, [options])](#resin.models.service.var.getAllByService) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.service.var.getAllByApplication) ⇒ Promise * [.get(id, key)](#resin.models.service.var.get) ⇒ Promise * [.set(id, key, value)](#resin.models.service.var.set) ⇒ Promise * [.remove(id, key)](#resin.models.service.var.remove) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.service.getAllByApplication) ⇒ Promise * [.image](#resin.models.image) : object * [.get(id, [options])](#resin.models.image.get) ⇒ Promise * [.getLogs(id)](#resin.models.image.getLogs) ⇒ Promise * [.billing](#resin.models.billing) : object * [.getAccount()](#resin.models.billing.getAccount) ⇒ Promise * [.getPlan()](#resin.models.billing.getPlan) ⇒ Promise * [.getBillingInfo()](#resin.models.billing.getBillingInfo) ⇒ Promise * [.updateBillingInfo()](#resin.models.billing.updateBillingInfo) ⇒ Promise * [.getInvoices()](#resin.models.billing.getInvoices) ⇒ Promise * [.downloadInvoice()](#resin.models.billing.downloadInvoice) ⇒ Promise * [.auth](#resin.auth) : object * [.twoFactor](#resin.auth.twoFactor) : object * [.isEnabled()](#resin.auth.twoFactor.isEnabled) ⇒ Promise * [.isPassed()](#resin.auth.twoFactor.isPassed) ⇒ Promise * [.challenge(code)](#resin.auth.twoFactor.challenge) ⇒ Promise * [.whoami()](#resin.auth.whoami) ⇒ Promise * [.authenticate(credentials)](#resin.auth.authenticate) ⇒ Promise * [.login(credentials)](#resin.auth.login) ⇒ Promise * [.loginWithToken(authToken)](#resin.auth.loginWithToken) ⇒ Promise * [.isLoggedIn()](#resin.auth.isLoggedIn) ⇒ Promise * [.getToken()](#resin.auth.getToken) ⇒ Promise * [.getUserId()](#resin.auth.getUserId) ⇒ Promise * [.getEmail()](#resin.auth.getEmail) ⇒ Promise * [.logout()](#resin.auth.logout) ⇒ Promise * [.register([credentials])](#resin.auth.register) ⇒ Promise * [.logs](#resin.logs) : object * [.subscribe(uuidOrId, [options])](#resin.logs.subscribe) ⇒ Promise * [.history(uuidOrId, [options])](#resin.logs.history) ⇒ Promise * [.LogSubscription](#resin.logs.LogSubscription) : EventEmitter * [.unsubscribe()](#resin.logs.LogSubscription.unsubscribe) * ["line"](#resin.logs.LogSubscription.event_line) * ["error"](#resin.logs.LogSubscription.event_error) * [.settings](#resin.settings) : object * [.get([key])](#resin.settings.get) ⇒ Promise * [.getAll()](#resin.settings.getAll) ⇒ Promise * [.setSharedOptions()](#resin.setSharedOptions) * [.fromSharedOptions()](#resin.fromSharedOptions) ### resin.interceptors : Array.<Interceptor> The current array of interceptors to use. Interceptors intercept requests made internally and are executed in the order they appear in this array for requests, and in the reverse order for responses. **Kind**: static property of [resin](#resin) **Summary**: Array of interceptors **Access**: public **Example** ```js resin.interceptors.push({ responseError: function (error) { console.log(error); throw error; }) }); ``` #### interceptors.Interceptor : object An interceptor implements some set of the four interception hook callbacks. To continue processing, each function should return a value or a promise that successfully resolves to a value. To halt processing, each function should throw an error or return a promise that rejects with an error. **Kind**: static typedef of [interceptors](#resin.interceptors) **Properties** | Name | Type | Description | | --- | --- | --- | | [request] | function | Callback invoked before requests are made. Called with the request options, should return (or resolve to) new request options, or throw/reject. | | [response] | function | Callback invoked before responses are returned. Called with the response, should return (or resolve to) a new response, or throw/reject. | | [requestError] | function | Callback invoked if an error happens before a request. Called with the error itself, caused by a preceeding request interceptor rejecting/throwing an error for the request, or a failing in preflight token validation. Should return (or resolve to) new request options, or throw/reject. | | [responseError] | function | Callback invoked if an error happens in the response. Called with the error itself, caused by a preceeding response interceptor rejecting/throwing an error for the request, a network error, or an error response from the server. Should return (or resolve to) a new response, or throw/reject. | ### resin.request : Object The resin-request instance used internally. This should not be necessary in normal usage, but can be useful if you want to make an API request directly, using the same token and hooks as the SDK. **Kind**: static property of [resin](#resin) **Summary**: Resin request instance **Access**: public **Example** ```js resin.request.send({ url: 'http://api.resin.io/ping' }); ``` ### resin.pine : Object The resin-pine instance used internally. This should not be necessary in normal usage, but can be useful if you want to directly make pine queries to the api for some resource that isn't directly supported in the SDK. **Kind**: static property of [resin](#resin) **Summary**: Resin pine instance **Access**: public **Example** ```js resin.pine.get({ resource: 'release/$count', options: { $filter: { belongs_to__application: applicationId } } }); ``` ### resin.errors : Object The resin-errors module used internally. This is provided primarily for convenience, and to avoid the necessity for separate resin-errors dependencies. You'll want to use this if you need to match on the specific type of error thrown by the SDK. **Kind**: static property of [resin](#resin) **Summary**: Resin errors module **Access**: public **Example** ```js resin.models.device.get(123).catch(function (error) { if (error.code === resin.errors.ResinDeviceNotFound.code) { ... } else if (error.code === resin.errors.ResinRequestError.code) { ... } }); ``` ### resin.models : object **Kind**: static namespace of [resin](#resin) * [.models](#resin.models) : object * [.application](#resin.models.application) : object * [.tags](#resin.models.application.tags) : object * [.getAllByApplication(nameOrId, [options])](#resin.models.application.tags.getAllByApplication) ⇒ Promise * [.getAll([options])](#resin.models.application.tags.getAll) ⇒ Promise * [.set(nameOrId, tagKey, value)](#resin.models.application.tags.set) ⇒ Promise * [.remove(nameOrId, tagKey)](#resin.models.application.tags.remove) ⇒ Promise * [.configVar](#resin.models.application.configVar) : object * [.getAllByApplication(nameOrId, [options])](#resin.models.application.configVar.getAllByApplication) ⇒ Promise * [.get(nameOrId, key)](#resin.models.application.configVar.get) ⇒ Promise * [.set(nameOrId, key, value)](#resin.models.application.configVar.set) ⇒ Promise * [.remove(nameOrId, key)](#resin.models.application.configVar.remove) ⇒ Promise * [.envVar](#resin.models.application.envVar) : object * [.getAllByApplication(nameOrId, [options])](#resin.models.application.envVar.getAllByApplication) ⇒ Promise * [.get(nameOrId, key)](#resin.models.application.envVar.get) ⇒ Promise * [.set(nameOrId, key, value)](#resin.models.application.envVar.set) ⇒ Promise * [.remove(nameOrId, key)](#resin.models.application.envVar.remove) ⇒ Promise * [.getAll([options])](#resin.models.application.getAll) ⇒ Promise * [.get(nameOrId, [options])](#resin.models.application.get) ⇒ Promise * [.getWithDeviceServiceDetails(nameOrId, [options])](#resin.models.application.getWithDeviceServiceDetails) ⇒ Promise * [.getAppByOwner(appName, owner, [options])](#resin.models.application.getAppByOwner) ⇒ Promise * [.has(nameOrId)](#resin.models.application.has) ⇒ Promise * [.hasAny()](#resin.models.application.hasAny) ⇒ Promise * [.create(options)](#resin.models.application.create) ⇒ Promise * [.remove(nameOrId)](#resin.models.application.remove) ⇒ Promise * [.restart(nameOrId)](#resin.models.application.restart) ⇒ Promise * ~~[.generateApiKey(nameOrId)](#resin.models.application.generateApiKey) ⇒ Promise~~ * [.generateProvisioningKey(nameOrId)](#resin.models.application.generateProvisioningKey) ⇒ Promise * [.purge(appId)](#resin.models.application.purge) ⇒ Promise * [.shutdown(appId, [options])](#resin.models.application.shutdown) ⇒ Promise * [.reboot(appId, [options])](#resin.models.application.reboot) ⇒ Promise * [.enableDeviceUrls(nameOrId)](#resin.models.application.enableDeviceUrls) ⇒ Promise * [.disableDeviceUrls(nameOrId)](#resin.models.application.disableDeviceUrls) ⇒ Promise * [.grantSupportAccess(nameOrId, expiryTimestamp)](#resin.models.application.grantSupportAccess) ⇒ Promise * [.revokeSupportAccess(nameOrId)](#resin.models.application.revokeSupportAccess) ⇒ Promise * [.device](#resin.models.device) : object * [.tags](#resin.models.device.tags) : object * [.getAllByApplication(nameOrId, [options])](#resin.models.device.tags.getAllByApplication) ⇒ Promise * [.getAllByDevice(uuidOrId, [options])](#resin.models.device.tags.getAllByDevice) ⇒ Promise * [.getAll([options])](#resin.models.device.tags.getAll) ⇒ Promise * [.set(uuidOrId, tagKey, value)](#resin.models.device.tags.set) ⇒ Promise * [.remove(uuidOrId, tagKey)](#resin.models.device.tags.remove) ⇒ Promise * [.configVar](#resin.models.device.configVar) : object * [.getAllByDevice(uuidOrId, [options])](#resin.models.device.configVar.getAllByDevice) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.device.configVar.getAllByApplication) ⇒ Promise * [.get(uuidOrId, key)](#resin.models.device.configVar.get) ⇒ Promise * [.set(uuidOrId, key, value)](#resin.models.device.configVar.set) ⇒ Promise * [.remove(uuidOrId, key)](#resin.models.device.configVar.remove) ⇒ Promise * [.envVar](#resin.models.device.envVar) : object * [.getAllByDevice(uuidOrId, [options])](#resin.models.device.envVar.getAllByDevice) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.device.envVar.getAllByApplication) ⇒ Promise * [.get(uuidOrId, key)](#resin.models.device.envVar.get) ⇒ Promise * [.set(uuidOrId, key, value)](#resin.models.device.envVar.set) ⇒ Promise * [.remove(uuidOrId, key)](#resin.models.device.envVar.remove) ⇒ Promise * [.serviceVar](#resin.models.device.serviceVar) : object * [.getAllByDevice(uuidOrId, [options])](#resin.models.device.serviceVar.getAllByDevice) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.device.serviceVar.getAllByApplication) ⇒ Promise * [.get(uuidOrId, id, key)](#resin.models.device.serviceVar.get) ⇒ Promise * [.set(uuidOrId, id, key, value)](#resin.models.device.serviceVar.set) ⇒ Promise * [.remove(uuidOrId, id, key)](#resin.models.device.serviceVar.remove) ⇒ Promise * [.getDashboardUrl(uuid)](#resin.models.device.getDashboardUrl) ⇒ String * [.getAll([options])](#resin.models.device.getAll) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.device.getAllByApplication) ⇒ Promise * [.getAllByParentDevice(parentUuidOrId, [options])](#resin.models.device.getAllByParentDevice) ⇒ Promise * [.get(uuidOrId, [options])](#resin.models.device.get) ⇒ Promise * [.getWithServiceDetails(uuidOrId, [options])](#resin.models.device.getWithServiceDetails) ⇒ Promise * [.getByName(name)](#resin.models.device.getByName) ⇒ Promise * [.getName(uuidOrId)](#resin.models.device.getName) ⇒ Promise * [.getApplicationName(uuidOrId)](#resin.models.device.getApplicationName) ⇒ Promise * ~~[.getApplicationInfo(uuidOrId)](#resin.models.device.getApplicationInfo) ⇒ Promise~~ * [.has(uuidOrId)](#resin.models.device.has) ⇒ Promise * [.isOnline(uuidOrId)](#resin.models.device.isOnline) ⇒ Promise * [.getLocalIPAddresses(uuidOrId)](#resin.models.device.getLocalIPAddresses) ⇒ Promise * [.remove(uuidOrId)](#resin.models.device.remove) ⇒ Promise * [.identify(uuidOrId)](#resin.models.device.identify) ⇒ Promise * [.rename(uuidOrId, newName)](#resin.models.device.rename) ⇒ Promise * [.note(uuidOrId, note)](#resin.models.device.note) ⇒ Promise * [.setCustomLocation(uuidOrId, location)](#resin.models.device.setCustomLocation) ⇒ Promise * [.unsetCustomLocation(uuidOrId)](#resin.models.device.unsetCustomLocation) ⇒ Promise * [.move(uuidOrId, applicationNameOrId)](#resin.models.device.move) ⇒ Promise * ~~[.startApplication(uuidOrId)](#resin.models.device.startApplication) ⇒ Promise~~ * ~~[.stopApplication(uuidOrId)](#resin.models.device.stopApplication) ⇒ Promise~~ * [.restartApplication(uuidOrId)](#resin.models.device.restartApplication) ⇒ Promise * [.startService(uuidOrId, imageId)](#resin.models.device.startService) ⇒ Promise * [.stopService(uuidOrId, imageId)](#resin.models.device.stopService) ⇒ Promise * [.restartService(uuidOrId, imageId)](#resin.models.device.restartService) ⇒ Promise * [.reboot(uuidOrId, [options])](#resin.models.device.reboot) ⇒ Promise * [.shutdown(uuidOrId, [options])](#resin.models.device.shutdown) ⇒ Promise * [.purge(uuidOrId)](#resin.models.device.purge) ⇒ Promise * [.update(uuidOrId, [options])](#resin.models.device.update) ⇒ Promise * [.getDisplayName(deviceTypeSlug)](#resin.models.device.getDisplayName) ⇒ Promise * [.getDeviceSlug(deviceTypeName)](#resin.models.device.getDeviceSlug) ⇒ Promise * [.getSupportedDeviceTypes()](#resin.models.device.getSupportedDeviceTypes) ⇒ Promise * [.getManifestBySlug(slug)](#resin.models.device.getManifestBySlug) ⇒ Promise * [.getManifestByApplication(nameOrId)](#resin.models.device.getManifestByApplication) ⇒ Promise * [.generateUniqueKey()](#resin.models.device.generateUniqueKey) ⇒ String * [.register(applicationNameOrId, [uuid])](#resin.models.device.register) ⇒ Promise * [.generateDeviceKey(uuidOrId)](#resin.models.device.generateDeviceKey) ⇒ Promise * [.hasDeviceUrl(uuidOrId)](#resin.models.device.hasDeviceUrl) ⇒ Promise * [.getDeviceUrl(uuidOrId)](#resin.models.device.getDeviceUrl) ⇒ Promise * [.enableDeviceUrl(uuidOrId)](#resin.models.device.enableDeviceUrl) ⇒ Promise * [.disableDeviceUrl(uuidOrId)](#resin.models.device.disableDeviceUrl) ⇒ Promise * [.ping(uuidOrId)](#resin.models.device.ping) ⇒ Promise * [.getStatus(device)](#resin.models.device.getStatus) ⇒ Promise * [.grantSupportAccess(uuidOrId, expiryTimestamp)](#resin.models.device.grantSupportAccess) ⇒ Promise * [.revokeSupportAccess(uuidOrId)](#resin.models.device.revokeSupportAccess) ⇒ Promise * [.lastOnline(device)](#resin.models.device.lastOnline) ⇒ String * [.apiKey](#resin.models.apiKey) : object * [.create(name, [description])](#resin.models.apiKey.create) ⇒ Promise * [.getAll([options])](#resin.models.apiKey.getAll) ⇒ Promise * [.update(id, apiKeyInfo)](#resin.models.apiKey.update) ⇒ Promise * [.revoke(id)](#resin.models.apiKey.revoke) ⇒ Promise * [.key](#resin.models.key) : object * [.getAll([options])](#resin.models.key.getAll) ⇒ Promise * [.get(id)](#resin.models.key.get) ⇒ Promise * [.remove(id)](#resin.models.key.remove) ⇒ Promise * [.create(title, key)](#resin.models.key.create) ⇒ Promise * [.os](#resin.models.os) : object * [.getDownloadSize(deviceType, [version])](#resin.models.os.getDownloadSize) ⇒ Promise * [.getSupportedVersions(deviceType)](#resin.models.os.getSupportedVersions) ⇒ Promise * [.getMaxSatisfyingVersion(deviceType, versionOrRange)](#resin.models.os.getMaxSatisfyingVersion) ⇒ Promise * [.getLastModified(deviceType, [version])](#resin.models.os.getLastModified) ⇒ Promise * [.download(deviceType, [version])](#resin.models.os.download) ⇒ Promise * [.getConfig(nameOrId, options)](#resin.models.os.getConfig) ⇒ Promise * [.config](#resin.models.config) : object * [.getAll()](#resin.models.config.getAll) ⇒ Promise * [.getDeviceTypes()](#resin.models.config.getDeviceTypes) ⇒ Promise * [.getDeviceOptions(deviceType)](#resin.models.config.getDeviceOptions) ⇒ Promise * [.release](#resin.models.release) : object * [.tags](#resin.models.release.tags) : object * [.getAllByApplication(nameOrId, [options])](#resin.models.release.tags.getAllByApplication) ⇒ Promise * [.getAllByRelease(id, [options])](#resin.models.release.tags.getAllByRelease) ⇒ Promise * [.getAll([options])](#resin.models.release.tags.getAll) ⇒ Promise * [.set(releaseId, tagKey, value)](#resin.models.release.tags.set) ⇒ Promise * [.remove(releaseId, tagKey)](#resin.models.release.tags.remove) ⇒ Promise * [.get(id, [options])](#resin.models.release.get) ⇒ Promise * [.getWithImageDetails(id, [options])](#resin.models.release.getWithImageDetails) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.release.getAllByApplication) ⇒ Promise * [.service](#resin.models.service) : object * [.var](#resin.models.service.var) : object * [.getAllByService(id, [options])](#resin.models.service.var.getAllByService) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.service.var.getAllByApplication) ⇒ Promise * [.get(id, key)](#resin.models.service.var.get) ⇒ Promise * [.set(id, key, value)](#resin.models.service.var.set) ⇒ Promise * [.remove(id, key)](#resin.models.service.var.remove) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.service.getAllByApplication) ⇒ Promise * [.image](#resin.models.image) : object * [.get(id, [options])](#resin.models.image.get) ⇒ Promise * [.getLogs(id)](#resin.models.image.getLogs) ⇒ Promise * [.billing](#resin.models.billing) : object * [.getAccount()](#resin.models.billing.getAccount) ⇒ Promise * [.getPlan()](#resin.models.billing.getPlan) ⇒ Promise * [.getBillingInfo()](#resin.models.billing.getBillingInfo) ⇒ Promise * [.updateBillingInfo()](#resin.models.billing.updateBillingInfo) ⇒ Promise * [.getInvoices()](#resin.models.billing.getInvoices) ⇒ Promise * [.downloadInvoice()](#resin.models.billing.downloadInvoice) ⇒ Promise #### models.application : object **Kind**: static namespace of [models](#resin.models) * [.application](#resin.models.application) : object * [.tags](#resin.models.application.tags) : object * [.getAllByApplication(nameOrId, [options])](#resin.models.application.tags.getAllByApplication) ⇒ Promise * [.getAll([options])](#resin.models.application.tags.getAll) ⇒ Promise * [.set(nameOrId, tagKey, value)](#resin.models.application.tags.set) ⇒ Promise * [.remove(nameOrId, tagKey)](#resin.models.application.tags.remove) ⇒ Promise * [.configVar](#resin.models.application.configVar) : object * [.getAllByApplication(nameOrId, [options])](#resin.models.application.configVar.getAllByApplication) ⇒ Promise * [.get(nameOrId, key)](#resin.models.application.configVar.get) ⇒ Promise * [.set(nameOrId, key, value)](#resin.models.application.configVar.set) ⇒ Promise * [.remove(nameOrId, key)](#resin.models.application.configVar.remove) ⇒ Promise * [.envVar](#resin.models.application.envVar) : object * [.getAllByApplication(nameOrId, [options])](#resin.models.application.envVar.getAllByApplication) ⇒ Promise * [.get(nameOrId, key)](#resin.models.application.envVar.get) ⇒ Promise * [.set(nameOrId, key, value)](#resin.models.application.envVar.set) ⇒ Promise * [.remove(nameOrId, key)](#resin.models.application.envVar.remove) ⇒ Promise * [.getAll([options])](#resin.models.application.getAll) ⇒ Promise * [.get(nameOrId, [options])](#resin.models.application.get) ⇒ Promise * [.getWithDeviceServiceDetails(nameOrId, [options])](#resin.models.application.getWithDeviceServiceDetails) ⇒ Promise * [.getAppByOwner(appName, owner, [options])](#resin.models.application.getAppByOwner) ⇒ Promise * [.has(nameOrId)](#resin.models.application.has) ⇒ Promise * [.hasAny()](#resin.models.application.hasAny) ⇒ Promise * [.create(options)](#resin.models.application.create) ⇒ Promise * [.remove(nameOrId)](#resin.models.application.remove) ⇒ Promise * [.restart(nameOrId)](#resin.models.application.restart) ⇒ Promise * ~~[.generateApiKey(nameOrId)](#resin.models.application.generateApiKey) ⇒ Promise~~ * [.generateProvisioningKey(nameOrId)](#resin.models.application.generateProvisioningKey) ⇒ Promise * [.purge(appId)](#resin.models.application.purge) ⇒ Promise * [.shutdown(appId, [options])](#resin.models.application.shutdown) ⇒ Promise * [.reboot(appId, [options])](#resin.models.application.reboot) ⇒ Promise * [.enableDeviceUrls(nameOrId)](#resin.models.application.enableDeviceUrls) ⇒ Promise * [.disableDeviceUrls(nameOrId)](#resin.models.application.disableDeviceUrls) ⇒ Promise * [.grantSupportAccess(nameOrId, expiryTimestamp)](#resin.models.application.grantSupportAccess) ⇒ Promise * [.revokeSupportAccess(nameOrId)](#resin.models.application.revokeSupportAccess) ⇒ Promise ##### application.tags : object **Kind**: static namespace of [application](#resin.models.application) * [.tags](#resin.models.application.tags) : object * [.getAllByApplication(nameOrId, [options])](#resin.models.application.tags.getAllByApplication) ⇒ Promise * [.getAll([options])](#resin.models.application.tags.getAll) ⇒ Promise * [.set(nameOrId, tagKey, value)](#resin.models.application.tags.set) ⇒ Promise * [.remove(nameOrId, tagKey)](#resin.models.application.tags.remove) ⇒ Promise ###### tags.getAllByApplication(nameOrId, [options]) ⇒ Promise **Kind**: static method of [tags](#resin.models.application.tags) **Summary**: Get all application tags for an application **Access**: public **Fulfil**: Object[] - application tags | Param | Type | Default | Description | | --- | --- | --- | --- | | nameOrId | String \| Number | | application name (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.application.tags.getAllByApplication('MyApp').then(function(tags) { console.log(tags); }); ``` **Example** ```js resin.models.application.tags.getAllByApplication(999999).then(function(tags) { console.log(tags); }); ``` **Example** ```js resin.models.application.tags.getAllByApplication('MyApp', function(error, tags) { if (error) throw error; console.log(tags) }); ``` ###### tags.getAll([options]) ⇒ Promise **Kind**: static method of [tags](#resin.models.application.tags) **Summary**: Get all application tags **Access**: public **Fulfil**: Object[] - application tags | Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.application.tags.getAll().then(function(tags) { console.log(tags); }); ``` **Example** ```js resin.models.application.tags.getAll(function(error, tags) { if (error) throw error; console.log(tags) }); ``` ###### tags.set(nameOrId, tagKey, value) ⇒ Promise **Kind**: static method of [tags](#resin.models.application.tags) **Summary**: Set an application tag **Access**: public | Param | Type | Description | | --- | --- | --- | | nameOrId | String \| Number | application name (string) or id (number) | | tagKey | String | tag key | | value | String \| undefined | tag value | **Example** ```js resin.models.application.tags.set('7cf02a6', 'EDITOR', 'vim'); ``` **Example** ```js resin.models.application.tags.set(123, 'EDITOR', 'vim'); ``` **Example** ```js resin.models.application.tags.set('7cf02a6', 'EDITOR', 'vim', function(error) { if (error) throw error; }); ``` ###### tags.remove(nameOrId, tagKey) ⇒ Promise **Kind**: static method of [tags](#resin.models.application.tags) **Summary**: Remove an application tag **Access**: public | Param | Type | Description | | --- | --- | --- | | nameOrId | String \| Number | application name (string) or id (number) | | tagKey | String | tag key | **Example** ```js resin.models.application.tags.remove('7cf02a6', 'EDITOR'); ``` **Example** ```js resin.models.application.tags.remove('7cf02a6', 'EDITOR', function(error) { if (error) throw error; }); ``` ##### application.configVar : object **Kind**: static namespace of [application](#resin.models.application) * [.configVar](#resin.models.application.configVar) : object * [.getAllByApplication(nameOrId, [options])](#resin.models.application.configVar.getAllByApplication) ⇒ Promise * [.get(nameOrId, key)](#resin.models.application.configVar.get) ⇒ Promise * [.set(nameOrId, key, value)](#resin.models.application.configVar.set) ⇒ Promise * [.remove(nameOrId, key)](#resin.models.application.configVar.remove) ⇒ Promise ###### configVar.getAllByApplication(nameOrId, [options]) ⇒ Promise **Kind**: static method of [configVar](#resin.models.application.configVar) **Summary**: Get all config variables for an application **Access**: public **Fulfil**: Object[] - application config variables | Param | Type | Default | Description | | --- | --- | --- | --- | | nameOrId | String \| Number | | application name (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.application.configVar.getAllByApplication('MyApp').then(function(vars) { console.log(vars); }); ``` **Example** ```js resin.models.application.configVar.getAllByApplication(999999).then(function(vars) { console.log(vars); }); ``` **Example** ```js resin.models.application.configVar.getAllByApplication('MyApp', function(error, vars) { if (error) throw error; console.log(vars) }); ``` ###### configVar.get(nameOrId, key) ⇒ Promise **Kind**: static method of [configVar](#resin.models.application.configVar) **Summary**: Get the value of a specific config variable **Access**: public **Fulfil**: String\|undefined - the config variable value (or undefined) | Param | Type | Description | | --- | --- | --- | | nameOrId | String \| Number | application name (string) or id (number) | | key | String | config variable name | **Example** ```js resin.models.application.configVar.get('MyApp', 'RESIN_VAR').then(function(value) { console.log(value); }); ``` **Example** ```js resin.models.application.configVar.get(999999, 'RESIN_VAR').then(function(value) { console.log(value); }); ``` **Example** ```js resin.models.application.configVar.get('MyApp', 'RESIN_VAR', function(error, value) { if (error) throw error; console.log(value) }); ``` ###### configVar.set(nameOrId, key, value) ⇒ Promise **Kind**: static method of [configVar](#resin.models.application.configVar) **Summary**: Set the value of a specific config variable **Access**: public | Param | Type | Description | | --- | --- | --- | | nameOrId | String \| Number | application name (string) or id (number) | | key | String | config variable name | | value | String | config variable value | **Example** ```js resin.models.application.configVar.set('MyApp', 'RESIN_VAR', 'newvalue').then(function() { ... }); ``` **Example** ```js resin.models.application.configVar.set(999999, 'RESIN_VAR', 'newvalue').then(function() { ... }); ``` **Example** ```js resin.models.application.configVar.set('MyApp', 'RESIN_VAR', 'newvalue', function(error) { if (error) throw error; ... }); ``` ###### configVar.remove(nameOrId, key) ⇒ Promise **Kind**: static method of [configVar](#resin.models.application.configVar) **Summary**: Clear the value of a specific config variable **Access**: public | Param | Type | Description | | --- | --- | --- | | nameOrId | String \| Number | application name (string) or id (number) | | key | String | config variable name | **Example** ```js resin.models.application.configVar.remove('MyApp', 'RESIN_VAR').then(function() { ... }); ``` **Example** ```js resin.models.application.configVar.remove(999999, 'RESIN_VAR').then(function() { ... }); ``` **Example** ```js resin.models.application.configVar.remove('MyApp', 'RESIN_VAR', function(error) { if (error) throw error; ... }); ``` ##### application.envVar : object **Kind**: static namespace of [application](#resin.models.application) * [.envVar](#resin.models.application.envVar) : object * [.getAllByApplication(nameOrId, [options])](#resin.models.application.envVar.getAllByApplication) ⇒ Promise * [.get(nameOrId, key)](#resin.models.application.envVar.get) ⇒ Promise * [.set(nameOrId, key, value)](#resin.models.application.envVar.set) ⇒ Promise * [.remove(nameOrId, key)](#resin.models.application.envVar.remove) ⇒ Promise ###### envVar.getAllByApplication(nameOrId, [options]) ⇒ Promise **Kind**: static method of [envVar](#resin.models.application.envVar) **Summary**: Get all environment variables for an application **Access**: public **Fulfil**: Object[] - application environment variables | Param | Type | Default | Description | | --- | --- | --- | --- | | nameOrId | String \| Number | | application name (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.application.envVar.getAllByApplication('MyApp').then(function(vars) { console.log(vars); }); ``` **Example** ```js resin.models.application.envVar.getAllByApplication(999999).then(function(vars) { console.log(vars); }); ``` **Example** ```js resin.models.application.envVar.getAllByApplication('MyApp', function(error, vars) { if (error) throw error; console.log(vars) }); ``` ###### envVar.get(nameOrId, key) ⇒ Promise **Kind**: static method of [envVar](#resin.models.application.envVar) **Summary**: Get the value of a specific environment variable **Access**: public **Fulfil**: String\|undefined - the environment variable value (or undefined) | Param | Type | Description | | --- | --- | --- | | nameOrId | String \| Number | application name (string) or id (number) | | key | String | environment variable name | **Example** ```js resin.models.application.envVar.get('MyApp', 'VAR').then(function(value) { console.log(value); }); ``` **Example** ```js resin.models.application.envVar.get(999999, 'VAR').then(function(value) { console.log(value); }); ``` **Example** ```js resin.models.application.envVar.get('MyApp', 'VAR', function(error, value) { if (error) throw error; console.log(value) }); ``` ###### envVar.set(nameOrId, key, value) ⇒ Promise **Kind**: static method of [envVar](#resin.models.application.envVar) **Summary**: Set the value of a specific environment variable **Access**: public | Param | Type | Description | | --- | --- | --- | | nameOrId | String \| Number | application name (string) or id (number) | | key | String | environment variable name | | value | String | environment variable value | **Example** ```js resin.models.application.envVar.set('MyApp', 'VAR', 'newvalue').then(function() { ... }); ``` **Example** ```js resin.models.application.envVar.set(999999, 'VAR', 'newvalue').then(function() { ... }); ``` **Example** ```js resin.models.application.envVar.set('MyApp', 'VAR', 'newvalue', function(error) { if (error) throw error; ... }); ``` ###### envVar.remove(nameOrId, key) ⇒ Promise **Kind**: static method of [envVar](#resin.models.application.envVar) **Summary**: Clear the value of a specific environment variable **Access**: public | Param | Type | Description | | --- | --- | --- | | nameOrId | String \| Number | application name (string) or id (number) | | key | String | environment variable name | **Example** ```js resin.models.application.envVar.remove('MyApp', 'VAR').then(function() { ... }); ``` **Example** ```js resin.models.application.envVar.remove(999999, 'VAR').then(function() { ... }); ``` **Example** ```js resin.models.application.envVar.remove('MyApp', 'VAR', function(error) { if (error) throw error; ... }); ``` ##### application.getAll([options]) ⇒ Promise **Kind**: static method of [application](#resin.models.application) **Summary**: Get all applications **Access**: public **Fulfil**: Object[] - applications | Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.application.getAll().then(function(applications) { console.log(applications); }); ``` **Example** ```js resin.models.application.getAll(function(error, applications) { if (error) throw error; console.log(applications); }); ``` ##### application.get(nameOrId, [options]) ⇒ Promise **Kind**: static method of [application](#resin.models.application) **Summary**: Get a single application **Access**: public **Fulfil**: Object - application | Param | Type | Default | Description | | --- | --- | --- | --- | | nameOrId | String \| Number | | application name (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.application.get('MyApp').then(function(application) { console.log(application); }); ``` **Example** ```js resin.models.application.get(123).then(function(application) { console.log(application); }); ``` **Example** ```js resin.models.application.get('MyApp', function(error, application) { if (error) throw error; console.log(application); }); ``` ##### application.getWithDeviceServiceDetails(nameOrId, [options]) ⇒ Promise This method does not map exactly to the underlying model: it runs a larger prebuilt query, and reformats it into an easy to use and understand format. If you want more control, or to see the raw model directly, use `application.get(uuidOrId, options)` instead. **Kind**: static method of [application](#resin.models.application) **Summary**: Get a single application and its deives, along with each device's associated services' essential details **Access**: public **Fulfil**: Object - application | Param | Type | Default | Description | | --- | --- | --- | --- | | nameOrId | String \| Number | | application name (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.application.getWithDeviceServiceDetails('7cf02a6').then(function(device) { console.log(device); }) ``` **Example** ```js resin.models.application.getWithDeviceServiceDetails(123).then(function(device) { console.log(device); }) ``` **Example** ```js resin.models.application.getWithDeviceServiceDetails('7cf02a6', function(error, device) { if (error) throw error; console.log(device); }); ``` ##### application.getAppByOwner(appName, owner, [options]) ⇒ Promise **Kind**: static method of [application](#resin.models.application) **Summary**: Get a single application using the appname and owner's username **Access**: public **Fulfil**: Object - application | Param | Type | Default | Description | | --- | --- | --- | --- | | appName | String | | application name | | owner | String | | The owner's username | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.application.getAppByOwner('MyApp', 'MyUser').then(function(application) { console.log(application); }); ``` ##### application.has(nameOrId) ⇒ Promise **Kind**: static method of [application](#resin.models.application) **Summary**: Check if an application exists **Access**: public **Fulfil**: Boolean - has application | Param | Type | Description | | --- | --- | --- | | nameOrId | String \| Number | application name (string) or id (number) | **Example** ```js resin.models.application.has('MyApp').then(function(hasApp) { console.log(hasApp); }); ``` **Example** ```js resin.models.application.has(123).then(function(hasApp) { console.log(hasApp); }); ``` **Example** ```js resin.models.application.has('MyApp', function(error, hasApp) { if (error) throw error; console.log(hasApp); }); ``` ##### application.hasAny() ⇒ Promise **Kind**: static method of [application](#resin.models.application) **Summary**: Check if the user has any applications **Access**: public **Fulfil**: Boolean - has any applications **Example** ```js resin.models.application.hasAny().then(function(hasAny) { console.log('Has any?', hasAny); }); ``` **Example** ```js resin.models.application.hasAny(function(error, hasAny) { if (error) throw error; console.log('Has any?', hasAny); }); ``` ##### application.create(options) ⇒ Promise **Kind**: static method of [application](#resin.models.application) **Summary**: Create an application **Access**: public **Fulfil**: Object - application | Param | Type | Description | | --- | --- | --- | | options | Object | application creation parameters | | options.name | String | application name | | [options.applicationType] | String | application type slug e.g. microservices-starter | | options.deviceType | String | device type slug | | [options.parent] | Number \| String | parent application name or id | **Example** ```js resin.models.application.create({ name: 'My App', applicationType: 'essentials', deviceType: 'raspberry-pi').then(function(application) { console.log(application); }); ``` **Example** ```js resin.models.application.create({ name: 'My App', applicationType: 'microservices', deviceType: 'raspberry-pi', parent: 'ParentApp' }).then(function(application) { console.log(application); }); ``` **Example** ```js resin.models.application.create({ name: 'My App', applicationType: 'microservices-starter', deviceType: 'raspberry-pi' }, function(error, application) { if (error) throw error; console.log(application); }); ``` ##### application.remove(nameOrId) ⇒ Promise **Kind**: static method of [application](#resin.models.application) **Summary**: Remove application **Access**: public | Param | Type | Description | | --- | --- | --- | | nameOrId | String \| Number | application name (string) or id (number) | **Example** ```js resin.models.application.remove('MyApp'); ``` **Example** ```js resin.models.application.remove(123); ``` **Example** ```js resin.models.application.remove('MyApp', function(error) { if (error) throw error; }); ``` ##### application.restart(nameOrId) ⇒ Promise **Kind**: static method of [application](#resin.models.application) **Summary**: Restart application **Access**: public | Param | Type | Description | | --- | --- | --- | | nameOrId | String \| Number | application name (string) or id (number) | **Example** ```js resin.models.application.restart('MyApp'); ``` **Example** ```js resin.models.application.restart(123); ``` **Example** ```js resin.models.application.restart('MyApp', function(error) { if (error) throw error; }); ``` ##### ~~application.generateApiKey(nameOrId) ⇒ Promise~~ ***Deprecated*** Generally you shouldn't use this method: if you're provisioning a recent ResinOS version (2.4.0+) then generateProvisioningKey should work just as well, but be more secure. **Kind**: static method of [application](#resin.models.application) **Summary**: Generate an API key for a specific application **Access**: public **Fulfil**: String - api key | Param | Type | Description | | --- | --- | --- | | nameOrId | String \| Number | application name (string) or id (number) | **Example** ```js resin.models.application.generateApiKey('MyApp').then(function(apiKey) { console.log(apiKey); }); ``` **Example** ```js resin.models.application.generateApiKey(123).then(function(apiKey) { console.log(apiKey); }); ``` **Example** ```js resin.models.application.generateApiKey('MyApp', function(error, apiKey) { if (error) throw error; console.log(apiKey); }); ``` ##### application.generateProvisioningKey(nameOrId) ⇒ Promise **Kind**: static method of [application](#resin.models.application) **Summary**: Generate a device provisioning key for a specific application **Access**: public **Fulfil**: String - device provisioning key | Param | Type | Description | | --- | --- | --- | | nameOrId | String \| Number | application name (string) or id (number) | **Example** ```js resin.models.application.generateProvisioningKey('MyApp').then(function(key) { console.log(key); }); ``` **Example** ```js resin.models.application.generateProvisioningKey(123).then(function(key) { console.log(key); }); ``` **Example** ```js resin.models.application.generateProvisioningKey('MyApp', function(error, key) { if (error) throw error; console.log(key); }); ``` ##### application.purge(appId) ⇒ Promise **Kind**: static method of [application](#resin.models.application) **Summary**: Purge devices by application id **Access**: public | Param | Type | Description | | --- | --- | --- | | appId | Number | application id | **Example** ```js resin.models.application.purge(123); ``` **Example** ```js resin.models.application.purge(123, function(error) { if (error) throw error; }); ``` ##### application.shutdown(appId, [options]) ⇒ Promise **Kind**: static method of [application](#resin.models.application) **Summary**: Shutdown devices by application id **Access**: public | Param | Type | Default | Description | | --- | --- | --- | --- | | appId | Number | | application id | | [options] | Object | | options | | [options.force] | Boolean | false | override update lock | **Example** ```js resin.models.application.shutdown(123); ``` **Example** ```js resin.models.application.shutdown(123, function(error) { if (error) throw error; }); ``` ##### application.reboot(appId, [options]) ⇒ Promise **Kind**: static method of [application](#resin.models.application) **Summary**: Reboot devices by application id **Access**: public | Param | Type | Default | Description | | --- | --- | --- | --- | | appId | Number | | application id | | [options] | Object | | options | | [options.force] | Boolean | false | override update lock | **Example** ```js resin.models.application.reboot(123); ``` **Example** ```js resin.models.application.reboot(123, function(error) { if (error) throw error; }); ``` ##### application.enableDeviceUrls(nameOrId) ⇒ Promise **Kind**: static method of [application](#resin.models.application) **Summary**: Enable device urls for all devices that belong to an application **Access**: public | Param | Type | Description | | --- | --- | --- | | nameOrId | String \| Number | application name (string) or id (number) | **Example** ```js resin.models.application.enableDeviceUrls('MyApp'); ``` **Example** ```js resin.models.application.enableDeviceUrls(123); ``` **Example** ```js resin.models.device.enableDeviceUrls('MyApp', function(error) { if (error) throw error; }); ``` ##### application.disableDeviceUrls(nameOrId) ⇒ Promise **Kind**: static method of [application](#resin.models.application) **Summary**: Disable device urls for all devices that belong to an application **Access**: public | Param | Type | Description | | --- | --- | --- | | nameOrId | String \| Number | application name (string) or id (number) | **Example** ```js resin.models.application.disableDeviceUrls('MyApp'); ``` **Example** ```js resin.models.application.disableDeviceUrls(123); ``` **Example** ```js resin.models.device.disableDeviceUrls('MyApp', function(error) { if (error) throw error; }); ``` ##### application.grantSupportAccess(nameOrId, expiryTimestamp) ⇒ Promise **Kind**: static method of [application](#resin.models.application) **Summary**: Grant support access to an application until a specified time **Access**: public | Param | Type | Description | | --- | --- | --- | | nameOrId | String \| Number | application name (string) or id (number) | | expiryTimestamp | Number | a timestamp in ms for when the support access will expire | **Example** ```js resin.models.application.grantSupportAccess('MyApp', Date.now() + 3600 * 1000); ``` **Example** ```js resin.models.application.grantSupportAccess(123, Date.now() + 3600 * 1000); ``` **Example** ```js resin.models.application.grantSupportAccess('MyApp', Date.now() + 3600 * 1000, function(error) { if (error) throw error; }); ``` ##### application.revokeSupportAccess(nameOrId) ⇒ Promise **Kind**: static method of [application](#resin.models.application) **Summary**: Revoke support access to an application **Access**: public | Param | Type | Description | | --- | --- | --- | | nameOrId | String \| Number | application name (string) or id (number) | **Example** ```js resin.models.application.revokeSupportAccess('MyApp'); ``` **Example** ```js resin.models.application.revokeSupportAccess(123); ``` **Example** ```js resin.models.application.revokeSupportAccess('MyApp', function(error) { if (error) throw error; }); ``` #### models.device : object **Kind**: static namespace of [models](#resin.models) * [.device](#resin.models.device) : object * [.tags](#resin.models.device.tags) : object * [.getAllByApplication(nameOrId, [options])](#resin.models.device.tags.getAllByApplication) ⇒ Promise * [.getAllByDevice(uuidOrId, [options])](#resin.models.device.tags.getAllByDevice) ⇒ Promise * [.getAll([options])](#resin.models.device.tags.getAll) ⇒ Promise * [.set(uuidOrId, tagKey, value)](#resin.models.device.tags.set) ⇒ Promise * [.remove(uuidOrId, tagKey)](#resin.models.device.tags.remove) ⇒ Promise * [.configVar](#resin.models.device.configVar) : object * [.getAllByDevice(uuidOrId, [options])](#resin.models.device.configVar.getAllByDevice) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.device.configVar.getAllByApplication) ⇒ Promise * [.get(uuidOrId, key)](#resin.models.device.configVar.get) ⇒ Promise * [.set(uuidOrId, key, value)](#resin.models.device.configVar.set) ⇒ Promise * [.remove(uuidOrId, key)](#resin.models.device.configVar.remove) ⇒ Promise * [.envVar](#resin.models.device.envVar) : object * [.getAllByDevice(uuidOrId, [options])](#resin.models.device.envVar.getAllByDevice) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.device.envVar.getAllByApplication) ⇒ Promise * [.get(uuidOrId, key)](#resin.models.device.envVar.get) ⇒ Promise * [.set(uuidOrId, key, value)](#resin.models.device.envVar.set) ⇒ Promise * [.remove(uuidOrId, key)](#resin.models.device.envVar.remove) ⇒ Promise * [.serviceVar](#resin.models.device.serviceVar) : object * [.getAllByDevice(uuidOrId, [options])](#resin.models.device.serviceVar.getAllByDevice) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.device.serviceVar.getAllByApplication) ⇒ Promise * [.get(uuidOrId, id, key)](#resin.models.device.serviceVar.get) ⇒ Promise * [.set(uuidOrId, id, key, value)](#resin.models.device.serviceVar.set) ⇒ Promise * [.remove(uuidOrId, id, key)](#resin.models.device.serviceVar.remove) ⇒ Promise * [.getDashboardUrl(uuid)](#resin.models.device.getDashboardUrl) ⇒ String * [.getAll([options])](#resin.models.device.getAll) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.device.getAllByApplication) ⇒ Promise * [.getAllByParentDevice(parentUuidOrId, [options])](#resin.models.device.getAllByParentDevice) ⇒ Promise * [.get(uuidOrId, [options])](#resin.models.device.get) ⇒ Promise * [.getWithServiceDetails(uuidOrId, [options])](#resin.models.device.getWithServiceDetails) ⇒ Promise * [.getByName(name)](#resin.models.device.getByName) ⇒ Promise * [.getName(uuidOrId)](#resin.models.device.getName) ⇒ Promise * [.getApplicationName(uuidOrId)](#resin.models.device.getApplicationName) ⇒ Promise * ~~[.getApplicationInfo(uuidOrId)](#resin.models.device.getApplicationInfo) ⇒ Promise~~ * [.has(uuidOrId)](#resin.models.device.has) ⇒ Promise * [.isOnline(uuidOrId)](#resin.models.device.isOnline) ⇒ Promise * [.getLocalIPAddresses(uuidOrId)](#resin.models.device.getLocalIPAddresses) ⇒ Promise * [.remove(uuidOrId)](#resin.models.device.remove) ⇒ Promise * [.identify(uuidOrId)](#resin.models.device.identify) ⇒ Promise * [.rename(uuidOrId, newName)](#resin.models.device.rename) ⇒ Promise * [.note(uuidOrId, note)](#resin.models.device.note) ⇒ Promise * [.setCustomLocation(uuidOrId, location)](#resin.models.device.setCustomLocation) ⇒ Promise * [.unsetCustomLocation(uuidOrId)](#resin.models.device.unsetCustomLocation) ⇒ Promise * [.move(uuidOrId, applicationNameOrId)](#resin.models.device.move) ⇒ Promise * ~~[.startApplication(uuidOrId)](#resin.models.device.startApplication) ⇒ Promise~~ * ~~[.stopApplication(uuidOrId)](#resin.models.device.stopApplication) ⇒ Promise~~ * [.restartApplication(uuidOrId)](#resin.models.device.restartApplication) ⇒ Promise * [.startService(uuidOrId, imageId)](#resin.models.device.startService) ⇒ Promise * [.stopService(uuidOrId, imageId)](#resin.models.device.stopService) ⇒ Promise * [.restartService(uuidOrId, imageId)](#resin.models.device.restartService) ⇒ Promise * [.reboot(uuidOrId, [options])](#resin.models.device.reboot) ⇒ Promise * [.shutdown(uuidOrId, [options])](#resin.models.device.shutdown) ⇒ Promise * [.purge(uuidOrId)](#resin.models.device.purge) ⇒ Promise * [.update(uuidOrId, [options])](#resin.models.device.update) ⇒ Promise * [.getDisplayName(deviceTypeSlug)](#resin.models.device.getDisplayName) ⇒ Promise * [.getDeviceSlug(deviceTypeName)](#resin.models.device.getDeviceSlug) ⇒ Promise * [.getSupportedDeviceTypes()](#resin.models.device.getSupportedDeviceTypes) ⇒ Promise * [.getManifestBySlug(slug)](#resin.models.device.getManifestBySlug) ⇒ Promise * [.getManifestByApplication(nameOrId)](#resin.models.device.getManifestByApplication) ⇒ Promise * [.generateUniqueKey()](#resin.models.device.generateUniqueKey) ⇒ String * [.register(applicationNameOrId, [uuid])](#resin.models.device.register) ⇒ Promise * [.generateDeviceKey(uuidOrId)](#resin.models.device.generateDeviceKey) ⇒ Promise * [.hasDeviceUrl(uuidOrId)](#resin.models.device.hasDeviceUrl) ⇒ Promise * [.getDeviceUrl(uuidOrId)](#resin.models.device.getDeviceUrl) ⇒ Promise * [.enableDeviceUrl(uuidOrId)](#resin.models.device.enableDeviceUrl) ⇒ Promise * [.disableDeviceUrl(uuidOrId)](#resin.models.device.disableDeviceUrl) ⇒ Promise * [.ping(uuidOrId)](#resin.models.device.ping) ⇒ Promise * [.getStatus(device)](#resin.models.device.getStatus) ⇒ Promise * [.grantSupportAccess(uuidOrId, expiryTimestamp)](#resin.models.device.grantSupportAccess) ⇒ Promise * [.revokeSupportAccess(uuidOrId)](#resin.models.device.revokeSupportAccess) ⇒ Promise * [.lastOnline(device)](#resin.models.device.lastOnline) ⇒ String ##### device.tags : object **Kind**: static namespace of [device](#resin.models.device) * [.tags](#resin.models.device.tags) : object * [.getAllByApplication(nameOrId, [options])](#resin.models.device.tags.getAllByApplication) ⇒ Promise * [.getAllByDevice(uuidOrId, [options])](#resin.models.device.tags.getAllByDevice) ⇒ Promise * [.getAll([options])](#resin.models.device.tags.getAll) ⇒ Promise * [.set(uuidOrId, tagKey, value)](#resin.models.device.tags.set) ⇒ Promise * [.remove(uuidOrId, tagKey)](#resin.models.device.tags.remove) ⇒ Promise ###### tags.getAllByApplication(nameOrId, [options]) ⇒ Promise **Kind**: static method of [tags](#resin.models.device.tags) **Summary**: Get all device tags for an application **Access**: public **Fulfil**: Object[] - device tags | Param | Type | Default | Description | | --- | --- | --- | --- | | nameOrId | String \| Number | | application name (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.device.tags.getAllByApplication('MyApp').then(function(tags) { console.log(tags); }); ``` **Example** ```js resin.models.device.tags.getAllByApplication(999999).then(function(tags) { console.log(tags); }); ``` **Example** ```js resin.models.device.tags.getAllByApplication('MyApp', function(error, tags) { if (error) throw error; console.log(tags) }); ``` ###### tags.getAllByDevice(uuidOrId, [options]) ⇒ Promise **Kind**: static method of [tags](#resin.models.device.tags) **Summary**: Get all device tags for a device **Access**: public **Fulfil**: Object[] - device tags | Param | Type | Default | Description | | --- | --- | --- | --- | | uuidOrId | String \| Number | | device uuid (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.device.tags.getAllByDevice('7cf02a6').then(function(tags) { console.log(tags); }); ``` **Example** ```js resin.models.device.tags.getAllByDevice(123).then(function(tags) { console.log(tags); }); ``` **Example** ```js resin.models.device.tags.getAllByDevice('7cf02a6', function(error, tags) { if (error) throw error; console.log(tags) }); ``` ###### tags.getAll([options]) ⇒ Promise **Kind**: static method of [tags](#resin.models.device.tags) **Summary**: Get all device tags **Access**: public **Fulfil**: Object[] - device tags | Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.device.tags.getAll().then(function(tags) { console.log(tags); }); ``` **Example** ```js resin.models.device.tags.getAll(function(error, tags) { if (error) throw error; console.log(tags) }); ``` ###### tags.set(uuidOrId, tagKey, value) ⇒ Promise **Kind**: static method of [tags](#resin.models.device.tags) **Summary**: Set a device tag **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | | tagKey | String | tag key | | value | String \| undefined | tag value | **Example** ```js resin.models.device.tags.set('7cf02a6', 'EDITOR', 'vim'); ``` **Example** ```js resin.models.device.tags.set(123, 'EDITOR', 'vim'); ``` **Example** ```js resin.models.device.tags.set('7cf02a6', 'EDITOR', 'vim', function(error) { if (error) throw error; }); ``` ###### tags.remove(uuidOrId, tagKey) ⇒ Promise **Kind**: static method of [tags](#resin.models.device.tags) **Summary**: Remove a device tag **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | | tagKey | String | tag key | **Example** ```js resin.models.device.tags.remove('7cf02a6', 'EDITOR'); ``` **Example** ```js resin.models.device.tags.remove('7cf02a6', 'EDITOR', function(error) { if (error) throw error; }); ``` ##### device.configVar : object **Kind**: static namespace of [device](#resin.models.device) * [.configVar](#resin.models.device.configVar) : object * [.getAllByDevice(uuidOrId, [options])](#resin.models.device.configVar.getAllByDevice) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.device.configVar.getAllByApplication) ⇒ Promise * [.get(uuidOrId, key)](#resin.models.device.configVar.get) ⇒ Promise * [.set(uuidOrId, key, value)](#resin.models.device.configVar.set) ⇒ Promise * [.remove(uuidOrId, key)](#resin.models.device.configVar.remove) ⇒ Promise ###### configVar.getAllByDevice(uuidOrId, [options]) ⇒ Promise **Kind**: static method of [configVar](#resin.models.device.configVar) **Summary**: Get all config variables for a device **Access**: public **Fulfil**: Object[] - device config variables | Param | Type | Default | Description | | --- | --- | --- | --- | | uuidOrId | String \| Number | | device uuid (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.device.configVar.getAllByDevice('7cf02a6').then(function(vars) { console.log(vars); }); ``` **Example** ```js resin.models.device.configVar.getAllByDevice(999999).then(function(vars) { console.log(vars); }); ``` **Example** ```js resin.models.device.configVar.getAllByDevice('7cf02a6', function(error, vars) { if (error) throw error; console.log(vars) }); ``` ###### configVar.getAllByApplication(nameOrId, [options]) ⇒ Promise **Kind**: static method of [configVar](#resin.models.device.configVar) **Summary**: Get all device config variables by application **Access**: public **Fulfil**: Object[] - device config variables | Param | Type | Default | Description | | --- | --- | --- | --- | | nameOrId | String \| Number | | application name (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.device.configVar.getAllByApplication('MyApp').then(function(vars) { console.log(vars); }); ``` **Example** ```js resin.models.device.configVar.getAllByApplication(999999).then(function(vars) { console.log(vars); }); ``` **Example** ```js resin.models.device.configVar.getAllByApplication('MyApp', function(error, vars) { if (error) throw error; console.log(vars) }); ``` ###### configVar.get(uuidOrId, key) ⇒ Promise **Kind**: static method of [configVar](#resin.models.device.configVar) **Summary**: Get the value of a specific config variable **Access**: public **Fulfil**: String\|undefined - the config variable value (or undefined) | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | | key | String | config variable name | **Example** ```js resin.models.device.configVar.get('7cf02a6', 'RESIN_VAR').then(function(value) { console.log(value); }); ``` **Example** ```js resin.models.device.configVar.get(999999, 'RESIN_VAR').then(function(value) { console.log(value); }); ``` **Example** ```js resin.models.device.configVar.get('7cf02a6', 'RESIN_VAR', function(error, value) { if (error) throw error; console.log(value) }); ``` ###### configVar.set(uuidOrId, key, value) ⇒ Promise **Kind**: static method of [configVar](#resin.models.device.configVar) **Summary**: Set the value of a specific config variable **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | | key | String | config variable name | | value | String | config variable value | **Example** ```js resin.models.device.configVar.set('7cf02a6', 'RESIN_VAR', 'newvalue').then(function() { ... }); ``` **Example** ```js resin.models.device.configVar.set(999999, 'RESIN_VAR', 'newvalue').then(function() { ... }); ``` **Example** ```js resin.models.device.configVar.set('7cf02a6', 'RESIN_VAR', 'newvalue', function(error) { if (error) throw error; ... }); ``` ###### configVar.remove(uuidOrId, key) ⇒ Promise **Kind**: static method of [configVar](#resin.models.device.configVar) **Summary**: Clear the value of a specific config variable **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | | key | String | config variable name | **Example** ```js resin.models.device.configVar.remove('7cf02a6', 'RESIN_VAR').then(function() { ... }); ``` **Example** ```js resin.models.device.configVar.remove(999999, 'RESIN_VAR').then(function() { ... }); ``` **Example** ```js resin.models.device.configVar.remove('7cf02a6', 'RESIN_VAR', function(error) { if (error) throw error; ... }); ``` ##### device.envVar : object **Kind**: static namespace of [device](#resin.models.device) * [.envVar](#resin.models.device.envVar) : object * [.getAllByDevice(uuidOrId, [options])](#resin.models.device.envVar.getAllByDevice) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.device.envVar.getAllByApplication) ⇒ Promise * [.get(uuidOrId, key)](#resin.models.device.envVar.get) ⇒ Promise * [.set(uuidOrId, key, value)](#resin.models.device.envVar.set) ⇒ Promise * [.remove(uuidOrId, key)](#resin.models.device.envVar.remove) ⇒ Promise ###### envVar.getAllByDevice(uuidOrId, [options]) ⇒ Promise **Kind**: static method of [envVar](#resin.models.device.envVar) **Summary**: Get all environment variables for a device **Access**: public **Fulfil**: Object[] - device environment variables | Param | Type | Default | Description | | --- | --- | --- | --- | | uuidOrId | String \| Number | | device uuid (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.device.envVar.getAllByDevice('7cf02a6').then(function(vars) { console.log(vars); }); ``` **Example** ```js resin.models.device.envVar.getAllByDevice(999999).then(function(vars) { console.log(vars); }); ``` **Example** ```js resin.models.device.envVar.getAllByDevice('7cf02a6', function(error, vars) { if (error) throw error; console.log(vars) }); ``` ###### envVar.getAllByApplication(nameOrId, [options]) ⇒ Promise **Kind**: static method of [envVar](#resin.models.device.envVar) **Summary**: Get all device environment variables by application **Access**: public **Fulfil**: Object[] - device environment variables | Param | Type | Default | Description | | --- | --- | --- | --- | | nameOrId | String \| Number | | application name (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.device.envVar.getAllByApplication('MyApp').then(function(vars) { console.log(vars); }); ``` **Example** ```js resin.models.device.envVar.getAllByApplication(999999).then(function(vars) { console.log(vars); }); ``` **Example** ```js resin.models.device.envVar.getAllByApplication('MyApp', function(error, vars) { if (error) throw error; console.log(vars) }); ``` ###### envVar.get(uuidOrId, key) ⇒ Promise **Kind**: static method of [envVar](#resin.models.device.envVar) **Summary**: Get the value of a specific environment variable **Access**: public **Fulfil**: String\|undefined - the environment variable value (or undefined) | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | | key | String | environment variable name | **Example** ```js resin.models.device.envVar.get('7cf02a6', 'VAR').then(function(value) { console.log(value); }); ``` **Example** ```js resin.models.device.envVar.get(999999, 'VAR').then(function(value) { console.log(value); }); ``` **Example** ```js resin.models.device.envVar.get('7cf02a6', 'VAR', function(error, value) { if (error) throw error; console.log(value) }); ``` ###### envVar.set(uuidOrId, key, value) ⇒ Promise **Kind**: static method of [envVar](#resin.models.device.envVar) **Summary**: Set the value of a specific environment variable **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | | key | String | environment variable name | | value | String | environment variable value | **Example** ```js resin.models.device.envVar.set('7cf02a6', 'VAR', 'newvalue').then(function() { ... }); ``` **Example** ```js resin.models.device.envVar.set(999999, 'VAR', 'newvalue').then(function() { ... }); ``` **Example** ```js resin.models.device.envVar.set('7cf02a6', 'VAR', 'newvalue', function(error) { if (error) throw error; ... }); ``` ###### envVar.remove(uuidOrId, key) ⇒ Promise **Kind**: static method of [envVar](#resin.models.device.envVar) **Summary**: Clear the value of a specific environment variable **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | | key | String | environment variable name | **Example** ```js resin.models.device.envVar.remove('7cf02a6', 'VAR').then(function() { ... }); ``` **Example** ```js resin.models.device.envVar.remove(999999, 'VAR').then(function() { ... }); ``` **Example** ```js resin.models.device.envVar.remove('7cf02a6', 'VAR', function(error) { if (error) throw error; ... }); ``` ##### device.serviceVar : object **Kind**: static namespace of [device](#resin.models.device) * [.serviceVar](#resin.models.device.serviceVar) : object * [.getAllByDevice(uuidOrId, [options])](#resin.models.device.serviceVar.getAllByDevice) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.device.serviceVar.getAllByApplication) ⇒ Promise * [.get(uuidOrId, id, key)](#resin.models.device.serviceVar.get) ⇒ Promise * [.set(uuidOrId, id, key, value)](#resin.models.device.serviceVar.set) ⇒ Promise * [.remove(uuidOrId, id, key)](#resin.models.device.serviceVar.remove) ⇒ Promise ###### serviceVar.getAllByDevice(uuidOrId, [options]) ⇒ Promise **Kind**: static method of [serviceVar](#resin.models.device.serviceVar) **Summary**: Get all service variable overrides for a device **Access**: public **Fulfil**: Object[] - service variables | Param | Type | Default | Description | | --- | --- | --- | --- | | uuidOrId | String \| Number | | device uuid (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.device.serviceVar.getAllByDevice('7cf02a6').then(function(vars) { console.log(vars); }); ``` **Example** ```js resin.models.device.serviceVar.getAllByDevice(999999).then(function(vars) { console.log(vars); }); ``` **Example** ```js resin.models.device.serviceVar.getAllByDevice('7cf02a6', function(error, vars) { if (error) throw error; console.log(vars) }); ``` ###### serviceVar.getAllByApplication(nameOrId, [options]) ⇒ Promise **Kind**: static method of [serviceVar](#resin.models.device.serviceVar) **Summary**: Get all device service variable overrides by application **Access**: public **Fulfil**: Object[] - service variables | Param | Type | Default | Description | | --- | --- | --- | --- | | nameOrId | String \| Number | | application name (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.device.serviceVar.getAllByApplication('MyApp').then(function(vars) { console.log(vars); }); ``` **Example** ```js resin.models.device.serviceVar.getAllByApplication(999999).then(function(vars) { console.log(vars); }); ``` **Example** ```js resin.models.device.serviceVar.getAllByApplication('MyApp', function(error, vars) { if (error) throw error; console.log(vars) }); ``` ###### serviceVar.get(uuidOrId, id, key) ⇒ Promise **Kind**: static method of [serviceVar](#resin.models.device.serviceVar) **Summary**: Get the overriden value of a service variable on a device **Access**: public **Fulfil**: String\|undefined - the variable value (or undefined) | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | | id | Number | service id | | key | String | variable name | **Example** ```js resin.models.device.serviceVar.get('7cf02a6', 123, 'VAR').then(function(value) { console.log(value); }); ``` **Example** ```js resin.models.device.serviceVar.get(999999, 123, 'VAR').then(function(value) { console.log(value); }); ``` **Example** ```js resin.models.device.serviceVar.get('7cf02a6', 123, 'VAR', function(error, value) { if (error) throw error; console.log(value) }); ``` ###### serviceVar.set(uuidOrId, id, key, value) ⇒ Promise **Kind**: static method of [serviceVar](#resin.models.device.serviceVar) **Summary**: Set the overriden value of a service variable on a device **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | | id | Number | service id | | key | String | variable name | | value | String | variable value | **Example** ```js resin.models.device.serviceVar.set('7cf02a6', 123, 'VAR', 'override').then(function() { ... }); ``` **Example** ```js resin.models.device.serviceVar.set(999999, 123, 'VAR', 'override').then(function() { ... }); ``` **Example** ```js resin.models.device.serviceVar.set('7cf02a6', 123, 'VAR', 'override', function(error) { if (error) throw error; ... }); ``` ###### serviceVar.remove(uuidOrId, id, key) ⇒ Promise **Kind**: static method of [serviceVar](#resin.models.device.serviceVar) **Summary**: Clear the overridden value of a service variable on a device **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | | id | Number | service id | | key | String | variable name | **Example** ```js resin.models.device.serviceVar.remove('7cf02a6', 123, 'VAR').then(function() { ... }); ``` **Example** ```js resin.models.device.serviceVar.remove(999999, 123, 'VAR').then(function() { ... }); ``` **Example** ```js resin.models.device.serviceVar.remove('7cf02a6', 123, 'VAR', function(error) { if (error) throw error; ... }); ``` ##### device.getDashboardUrl(uuid) ⇒ String **Kind**: static method of [device](#resin.models.device) **Summary**: Get Dashboard URL for a specific device **Returns**: String - - Dashboard URL for the specific device **Throws**: - Exception if the uuid is empty | Param | Type | Description | | --- | --- | --- | | uuid | String | Device uuid | **Example** ```js dashboardDeviceUrl = resin.models.device.getDashboardUrl('a44b544b8cc24d11b036c659dfeaccd8') ``` ##### device.getAll([options]) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Get all devices **Access**: public **Fulfil**: Object[] - devices | Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.device.getAll().then(function(devices) { console.log(devices); }); ``` **Example** ```js resin.models.device.getAll(function(error, devices) { if (error) throw error; console.log(devices); }); ``` ##### device.getAllByApplication(nameOrId, [options]) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Get all devices by application **Access**: public **Fulfil**: Object[] - devices | Param | Type | Default | Description | | --- | --- | --- | --- | | nameOrId | String \| Number | | application name (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.device.getAllByApplication('MyApp').then(function(devices) { console.log(devices); }); ``` **Example** ```js resin.models.device.getAllByApplication(123).then(function(devices) { console.log(devices); }); ``` **Example** ```js resin.models.device.getAllByApplication('MyApp', function(error, devices) { if (error) throw error; console.log(devices); }); ``` ##### device.getAllByParentDevice(parentUuidOrId, [options]) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Get all devices by parent device **Access**: public **Fulfil**: Object[] - devices | Param | Type | Default | Description | | --- | --- | --- | --- | | parentUuidOrId | String \| Number | | parent device uuid (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.device.getAllByParentDevice('7cf02a6').then(function(devices) { console.log(devices); }); ``` **Example** ```js resin.models.device.getAllByParentDevice(123).then(function(devices) { console.log(devices); }); ``` **Example** ```js resin.models.device.getAllByParentDevice('7cf02a6', function(error, devices) { if (error) throw error; console.log(devices); }); ``` ##### device.get(uuidOrId, [options]) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Get a single device **Access**: public **Fulfil**: Object - device | Param | Type | Default | Description | | --- | --- | --- | --- | | uuidOrId | String \| Number | | device uuid (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.device.get('7cf02a6').then(function(device) { console.log(device); }) ``` **Example** ```js resin.models.device.get(123).then(function(device) { console.log(device); }) ``` **Example** ```js resin.models.device.get('7cf02a6', function(error, device) { if (error) throw error; console.log(device); }); ``` ##### device.getWithServiceDetails(uuidOrId, [options]) ⇒ Promise This method does not map exactly to the underlying model: it runs a larger prebuilt query, and reformats it into an easy to use and understand format. If you want more control, or to see the raw model directly, use `device.get(uuidOrId, options)` instead. **Kind**: static method of [device](#resin.models.device) **Summary**: Get a single device along with its associated services' essential details **Access**: public **Fulfil**: Object - device with service details | Param | Type | Default | Description | | --- | --- | --- | --- | | uuidOrId | String \| Number | | device uuid (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.device.getWithServiceDetails('7cf02a6').then(function(device) { console.log(device); }) ``` **Example** ```js resin.models.device.getWithServiceDetails(123).then(function(device) { console.log(device); }) ``` **Example** ```js resin.models.device.getWithServiceDetails('7cf02a6', function(error, device) { if (error) throw error; console.log(device); }); ``` ##### device.getByName(name) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Get devices by name **Access**: public **Fulfil**: Object[] - devices | Param | Type | Description | | --- | --- | --- | | name | String | device name | **Example** ```js resin.models.device.getByName('MyDevice').then(function(devices) { console.log(devices); }); ``` **Example** ```js resin.models.device.getByName('MyDevice', function(error, devices) { if (error) throw error; console.log(devices); }); ``` ##### device.getName(uuidOrId) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Get the name of a device **Access**: public **Fulfil**: String - device name | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | **Example** ```js resin.models.device.getName('7cf02a6').then(function(deviceName) { console.log(deviceName); }); ``` **Example** ```js resin.models.device.getName(123).then(function(deviceName) { console.log(deviceName); }); ``` **Example** ```js resin.models.device.getName('7cf02a6', function(error, deviceName) { if (error) throw error; console.log(deviceName); }); ``` ##### device.getApplicationName(uuidOrId) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Get application name **Access**: public **Fulfil**: String - application name | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | **Example** ```js resin.models.device.getApplicationName('7cf02a6').then(function(applicationName) { console.log(applicationName); }); ``` **Example** ```js resin.models.device.getApplicationName(123).then(function(applicationName) { console.log(applicationName); }); ``` **Example** ```js resin.models.device.getApplicationName('7cf02a6', function(error, applicationName) { if (error) throw error; console.log(applicationName); }); ``` ##### ~~device.getApplicationInfo(uuidOrId) ⇒ Promise~~ ***Deprecated*** This is not supported on multicontainer devices, and will be removed in a future major release **Kind**: static method of [device](#resin.models.device) **Summary**: Get application container information **Access**: public **Fulfil**: Object - application info | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | **Example** ```js resin.models.device.getApplicationInfo('7cf02a6').then(function(appInfo) { console.log(appInfo); }); ``` **Example** ```js resin.models.device.getApplicationInfo(123).then(function(appInfo) { console.log(appInfo); }); ``` **Example** ```js resin.models.device.getApplicationInfo('7cf02a6', function(error, appInfo) { if (error) throw error; console.log(appInfo); }); ``` ##### device.has(uuidOrId) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Check if a device exists **Access**: public **Fulfil**: Boolean - has device | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | **Example** ```js resin.models.device.has('7cf02a6').then(function(hasDevice) { console.log(hasDevice); }); ``` **Example** ```js resin.models.device.has(123).then(function(hasDevice) { console.log(hasDevice); }); ``` **Example** ```js resin.models.device.has('7cf02a6', function(error, hasDevice) { if (error) throw error; console.log(hasDevice); }); ``` ##### device.isOnline(uuidOrId) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Check if a device is online **Access**: public **Fulfil**: Boolean - is device online | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | **Example** ```js resin.models.device.isOnline('7cf02a6').then(function(isOnline) { console.log('Is device online?', isOnline); }); ``` **Example** ```js resin.models.device.isOnline(123).then(function(isOnline) { console.log('Is device online?', isOnline); }); ``` **Example** ```js resin.models.device.isOnline('7cf02a6', function(error, isOnline) { if (error) throw error; console.log('Is device online?', isOnline); }); ``` ##### device.getLocalIPAddresses(uuidOrId) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Get the local IP addresses of a device **Access**: public **Fulfil**: String[] - local ip addresses **Reject**: Error Will reject if the device is offline | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | **Example** ```js resin.models.device.getLocalIPAddresses('7cf02a6').then(function(localIPAddresses) { localIPAddresses.forEach(function(localIP) { console.log(localIP); }); }); ``` **Example** ```js resin.models.device.getLocalIPAddresses(123).then(function(localIPAddresses) { localIPAddresses.forEach(function(localIP) { console.log(localIP); }); }); ``` **Example** ```js resin.models.device.getLocalIPAddresses('7cf02a6', function(error, localIPAddresses) { if (error) throw error; localIPAddresses.forEach(function(localIP) { console.log(localIP); }); }); ``` ##### device.remove(uuidOrId) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Remove device **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | **Example** ```js resin.models.device.remove('7cf02a6'); ``` **Example** ```js resin.models.device.remove(123); ``` **Example** ```js resin.models.device.remove('7cf02a6', function(error) { if (error) throw error; }); ``` ##### device.identify(uuidOrId) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Identify device **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | **Example** ```js resin.models.device.identify('7cf02a6'); ``` **Example** ```js resin.models.device.identify(123); ``` **Example** ```js resin.models.device.identify('7cf02a6', function(error) { if (error) throw error; }); ``` ##### device.rename(uuidOrId, newName) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Rename device **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | | newName | String | the device new name | **Example** ```js resin.models.device.rename('7cf02a6', 'NewName'); ``` **Example** ```js resin.models.device.rename(123, 'NewName'); ``` **Example** ```js resin.models.device.rename('7cf02a6', 'NewName', function(error) { if (error) throw error; }); ``` ##### device.note(uuidOrId, note) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Note a device **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | | note | String | the note | **Example** ```js resin.models.device.note('7cf02a6', 'My useful note'); ``` **Example** ```js resin.models.device.note(123, 'My useful note'); ``` **Example** ```js resin.models.device.note('7cf02a6', 'My useful note', function(error) { if (error) throw error; }); ``` ##### device.setCustomLocation(uuidOrId, location) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Set a custom location for a device **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | | location | Object | the location ({ latitude: 123, longitude: 456 }) | **Example** ```js resin.models.device.setCustomLocation('7cf02a6', { latitude: 123, longitude: 456 }); ``` **Example** ```js resin.models.device.setCustomLocation(123, { latitude: 123, longitude: 456 }); ``` **Example** ```js resin.models.device.setCustomLocation('7cf02a6', { latitude: 123, longitude: 456 }, function(error) { if (error) throw error; }); ``` ##### device.unsetCustomLocation(uuidOrId) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Clear the custom location of a device **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | **Example** ```js resin.models.device.unsetCustomLocation('7cf02a6'); ``` **Example** ```js resin.models.device.unsetCustomLocation(123); ``` **Example** ```js resin.models.device.unsetLocation('7cf02a6', function(error) { if (error) throw error; }); ``` ##### device.move(uuidOrId, applicationNameOrId) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Move a device to another application **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | | applicationNameOrId | String \| Number | application name (string) or id (number) | **Example** ```js resin.models.device.move('7cf02a6', 'MyApp'); ``` **Example** ```js resin.models.device.move(123, 'MyApp'); ``` **Example** ```js resin.models.device.move(123, 456); ``` **Example** ```js resin.models.device.move('7cf02a6', 'MyApp', function(error) { if (error) throw error; }); ``` ##### ~~device.startApplication(uuidOrId) ⇒ Promise~~ ***Deprecated*** This is not supported on multicontainer devices, and will be removed in a future major release **Kind**: static method of [device](#resin.models.device) **Summary**: Start application on device **Access**: public **Fulfil**: String - application container id | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | **Example** ```js resin.models.device.startApplication('7cf02a6').then(function(containerId) { console.log(containerId); }); ``` **Example** ```js resin.models.device.startApplication(123).then(function(containerId) { console.log(containerId); }); ``` **Example** ```js resin.models.device.startApplication('7cf02a6', function(error, containerId) { if (error) throw error; console.log(containerId); }); ``` ##### ~~device.stopApplication(uuidOrId) ⇒ Promise~~ ***Deprecated*** This is not supported on multicontainer devices, and will be removed in a future major release **Kind**: static method of [device](#resin.models.device) **Summary**: Stop application on device **Access**: public **Fulfil**: String - application container id | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | **Example** ```js resin.models.device.stopApplication('7cf02a6').then(function(containerId) { console.log(containerId); }); ``` **Example** ```js resin.models.device.stopApplication(123).then(function(containerId) { console.log(containerId); }); ``` **Example** ```js resin.models.device.stopApplication('7cf02a6', function(error, containerId) { if (error) throw error; console.log(containerId); }); ``` ##### device.restartApplication(uuidOrId) ⇒ Promise This function restarts the Docker container running the application on the device, but doesn't reboot the device itself. **Kind**: static method of [device](#resin.models.device) **Summary**: Restart application on device **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | **Example** ```js resin.models.device.restartApplication('7cf02a6'); ``` **Example** ```js resin.models.device.restartApplication(123); ``` **Example** ```js resin.models.device.restartApplication('7cf02a6', function(error) { if (error) throw error; }); ``` ##### device.startService(uuidOrId, imageId) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Start a service on a device **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | | imageId | Number | id of the image to start | **Example** ```js resin.models.device.startService('7cf02a6', 123).then(function() { ... }); ``` **Example** ```js resin.models.device.startService(1, 123).then(function() { ... }); ``` **Example** ```js resin.models.device.startService('7cf02a6', 123, function(error) { if (error) throw error; ... }); ``` ##### device.stopService(uuidOrId, imageId) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Stop a service on a device **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | | imageId | Number | id of the image to stop | **Example** ```js resin.models.device.stopService('7cf02a6', 123).then(function() { ... }); ``` **Example** ```js resin.models.device.stopService(1, 123).then(function() { ... }); ``` **Example** ```js resin.models.device.stopService('7cf02a6', 123, function(error) { if (error) throw error; ... }); ``` ##### device.restartService(uuidOrId, imageId) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Restart a service on a device **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | | imageId | Number | id of the image to restart | **Example** ```js resin.models.device.restartService('7cf02a6', 123).then(function() { ... }); ``` **Example** ```js resin.models.device.restartService(1, 123).then(function() { ... }); ``` **Example** ```js resin.models.device.restartService('7cf02a6', 123, function(error) { if (error) throw error; ... }); ``` ##### device.reboot(uuidOrId, [options]) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Reboot device **Access**: public | Param | Type | Default | Description | | --- | --- | --- | --- | | uuidOrId | String \| Number | | device uuid (string) or id (number) | | [options] | Object | | options | | [options.force] | Boolean | false | override update lock | **Example** ```js resin.models.device.reboot('7cf02a6'); ``` **Example** ```js resin.models.device.reboot(123); ``` **Example** ```js resin.models.device.reboot('7cf02a6', function(error) { if (error) throw error; }); ``` ##### device.shutdown(uuidOrId, [options]) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Shutdown device **Access**: public | Param | Type | Default | Description | | --- | --- | --- | --- | | uuidOrId | String \| Number | | device uuid (string) or id (number) | | [options] | Object | | options | | [options.force] | Boolean | false | override update lock | **Example** ```js resin.models.device.shutdown('7cf02a6'); ``` **Example** ```js resin.models.device.shutdown(123); ``` **Example** ```js resin.models.device.shutdown('7cf02a6', function(error) { if (error) throw error; }); ``` ##### device.purge(uuidOrId) ⇒ Promise This function clears the user application's `/data` directory. **Kind**: static method of [device](#resin.models.device) **Summary**: Purge device **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | **Example** ```js resin.models.device.purge('7cf02a6'); ``` **Example** ```js resin.models.device.purge(123); ``` **Example** ```js resin.models.device.purge('7cf02a6', function(error) { if (error) throw error; }); ``` ##### device.update(uuidOrId, [options]) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Trigger an update check on the supervisor **Access**: public | Param | Type | Default | Description | | --- | --- | --- | --- | | uuidOrId | String \| Number | | device uuid (string) or id (number) | | [options] | Object | | options | | [options.force] | Boolean | false | override update lock | **Example** ```js resin.models.device.update('7cf02a6', { force: true }); ``` **Example** ```js resin.models.device.update(123, { force: true }); ``` **Example** ```js resin.models.device.update('7cf02a6', { force: true }, function(error) { if (error) throw error; }); ``` ##### device.getDisplayName(deviceTypeSlug) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Get display name for a device **Access**: public **Fulfil**: String - device display name **See**: [module:resin.models.device.getSupportedDeviceTypes](module:resin.models.device.getSupportedDeviceTypes) for a list of supported devices | Param | Type | Description | | --- | --- | --- | | deviceTypeSlug | String | device type slug | **Example** ```js resin.models.device.getDisplayName('raspberry-pi').then(function(deviceTypeName) { console.log(deviceTypeName); // Raspberry Pi }); ``` **Example** ```js resin.models.device.getDisplayName('raspberry-pi', function(error, deviceTypeName) { if (error) throw error; console.log(deviceTypeName); // Raspberry Pi }); ``` ##### device.getDeviceSlug(deviceTypeName) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Get device slug **Access**: public **Fulfil**: String - device slug name **See**: [module:resin.models.device.getSupportedDeviceTypes](module:resin.models.device.getSupportedDeviceTypes) for a list of supported devices | Param | Type | Description | | --- | --- | --- | | deviceTypeName | String | device type name | **Example** ```js resin.models.device.getDeviceSlug('Raspberry Pi').then(function(deviceTypeSlug) { console.log(deviceTypeSlug); // raspberry-pi }); ``` **Example** ```js resin.models.device.getDeviceSlug('Raspberry Pi', function(error, deviceTypeSlug) { if (error) throw error; console.log(deviceTypeSlug); // raspberry-pi }); ``` ##### device.getSupportedDeviceTypes() ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Get supported device types **Access**: public **Fulfil**: String[] - supported device types **Example** ```js resin.models.device.getSupportedDeviceTypes().then(function(supportedDeviceTypes) { supportedDeviceTypes.forEach(function(supportedDeviceType) { console.log('Resin supports:', supportedDeviceType); }); }); ``` **Example** ```js resin.models.device.getSupportedDeviceTypes(function(error, supportedDeviceTypes) { if (error) throw error; supportedDeviceTypes.forEach(function(supportedDeviceType) { console.log('Resin supports:', supportedDeviceType); }); }); ``` ##### device.getManifestBySlug(slug) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Get a device manifest by slug **Access**: public **Fulfil**: Object - device manifest | Param | Type | Description | | --- | --- | --- | | slug | String | device slug | **Example** ```js resin.models.device.getManifestBySlug('raspberry-pi').then(function(manifest) { console.log(manifest); }); ``` **Example** ```js resin.models.device.getManifestBySlug('raspberry-pi', function(error, manifest) { if (error) throw error; console.log(manifest); }); ``` ##### device.getManifestByApplication(nameOrId) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Get a device manifest by application name **Access**: public **Fulfil**: Object - device manifest | Param | Type | Description | | --- | --- | --- | | nameOrId | String \| Number | application name (string) or id (number) | **Example** ```js resin.models.device.getManifestByApplication('MyApp').then(function(manifest) { console.log(manifest); }); ``` **Example** ```js resin.models.device.getManifestByApplication(123).then(function(manifest) { console.log(manifest); }); ``` **Example** ```js resin.models.device.getManifestByApplication('MyApp', function(error, manifest) { if (error) throw error; console.log(manifest); }); ``` ##### device.generateUniqueKey() ⇒ String **Kind**: static method of [device](#resin.models.device) **Summary**: Generate a random key, useful for both uuid and api key. **Returns**: String - A generated key **Access**: public **Example** ```js randomKey = resin.models.device.generateUniqueKey(); // randomKey is a randomly generated key that can be used as either a uuid or an api key console.log(randomKey); ``` ##### device.register(applicationNameOrId, [uuid]) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Register a new device with a Resin.io application. **Access**: public **Fulfil**: Object Device registration info ({ id: "...", uuid: "...", api_key: "..." }) | Param | Type | Description | | --- | --- | --- | | applicationNameOrId | String \| Number | application name (string) or id (number) | | [uuid] | String | device uuid | **Example** ```js var uuid = resin.models.device.generateUniqueKey(); resin.models.device.register('MyApp', uuid).then(function(registrationInfo) { console.log(registrationInfo); }); ``` **Example** ```js var uuid = resin.models.device.generateUniqueKey(); resin.models.device.register(123, uuid).then(function(registrationInfo) { console.log(registrationInfo); }); ``` **Example** ```js var uuid = resin.models.device.generateUniqueKey(); resin.models.device.register('MyApp', uuid, function(error, registrationInfo) { if (error) throw error; console.log(registrationInfo); }); ``` ##### device.generateDeviceKey(uuidOrId) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Generate a device key **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | **Example** ```js resin.models.device.generateDeviceKey('7cf02a6').then(function(deviceApiKey) { console.log(deviceApiKey); }); ``` **Example** ```js resin.models.device.generateDeviceKey(123).then(function(deviceApiKey) { console.log(deviceApiKey); }); ``` **Example** ```js resin.models.device.generateDeviceKey('7cf02a6', function(error, deviceApiKey) { if (error) throw error; console.log(deviceApiKey); }); ``` ##### device.hasDeviceUrl(uuidOrId) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Check if a device is web accessible with device utls **Access**: public **Fulfil**: Boolean - has device url | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | **Example** ```js resin.models.device.hasDeviceUrl('7cf02a6').then(function(hasDeviceUrl) { if (hasDeviceUrl) { console.log('The device has device URL enabled'); } }); ``` **Example** ```js resin.models.device.hasDeviceUrl(123).then(function(hasDeviceUrl) { if (hasDeviceUrl) { console.log('The device has device URL enabled'); } }); ``` **Example** ```js resin.models.device.hasDeviceUrl('7cf02a6', function(error, hasDeviceUrl) { if (error) throw error; if (hasDeviceUrl) { console.log('The device has device URL enabled'); } }); ``` ##### device.getDeviceUrl(uuidOrId) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Get a device url **Access**: public **Fulfil**: String - device url | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | **Example** ```js resin.models.device.getDeviceUrl('7cf02a6').then(function(url) { console.log(url); }); ``` **Example** ```js resin.models.device.getDeviceUrl(123).then(function(url) { console.log(url); }); ``` **Example** ```js resin.models.device.getDeviceUrl('7cf02a6', function(error, url) { if (error) throw error; console.log(url); }); ``` ##### device.enableDeviceUrl(uuidOrId) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Enable device url for a device **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | **Example** ```js resin.models.device.enableDeviceUrl('7cf02a6'); ``` **Example** ```js resin.models.device.enableDeviceUrl(123); ``` **Example** ```js resin.models.device.enableDeviceUrl('7cf02a6', function(error) { if (error) throw error; }); ``` ##### device.disableDeviceUrl(uuidOrId) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Disable device url for a device **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | **Example** ```js resin.models.device.disableDeviceUrl('7cf02a6'); ``` **Example** ```js resin.models.device.disableDeviceUrl(123); ``` **Example** ```js resin.models.device.disableDeviceUrl('7cf02a6', function(error) { if (error) throw error; }); ``` ##### device.ping(uuidOrId) ⇒ Promise This is useful to signal that the supervisor is alive and responding. **Kind**: static method of [device](#resin.models.device) **Summary**: Ping a device **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | **Example** ```js resin.models.device.ping('7cf02a6'); ``` **Example** ```js resin.models.device.ping(123); ``` **Example** ```js resin.models.device.ping('7cf02a6', function(error) { if (error) throw error; }); ``` ##### device.getStatus(device) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Get the status of a device **Access**: public **Fulfil**: String - device status | Param | Type | Description | | --- | --- | --- | | device | Object | A device object | **Example** ```js resin.models.device.getStatus(device).then(function(status) { console.log(status); }); ``` **Example** ```js resin.models.device.getStatus(device, function(error, status) { if (error) throw error; console.log(status); }); ``` ##### device.grantSupportAccess(uuidOrId, expiryTimestamp) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Grant support access to a device until a specified time **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | | expiryTimestamp | Number | a timestamp in ms for when the support access will expire | **Example** ```js resin.models.device.grantSupportAccess('7cf02a6', Date.now() + 3600 * 1000); ``` **Example** ```js resin.models.device.grantSupportAccess(123, Date.now() + 3600 * 1000); ``` **Example** ```js resin.models.device.grantSupportAccess('7cf02a6', Date.now() + 3600 * 1000, function(error) { if (error) throw error; }); ``` ##### device.revokeSupportAccess(uuidOrId) ⇒ Promise **Kind**: static method of [device](#resin.models.device) **Summary**: Revoke support access to a device **Access**: public | Param | Type | Description | | --- | --- | --- | | uuidOrId | String \| Number | device uuid (string) or id (number) | **Example** ```js resin.models.device.revokeSupportAccess('7cf02a6'); ``` **Example** ```js resin.models.device.revokeSupportAccess(123); ``` **Example** ```js resin.models.device.revokeSupportAccess('7cf02a6', function(error) { if (error) throw error; }); ``` ##### device.lastOnline(device) ⇒ String If the device has never been online this method returns the string `Connecting...`. **Kind**: static method of [device](#resin.models.device) **Summary**: Get a string showing when a device was last set as online **Access**: public | Param | Type | Description | | --- | --- | --- | | device | Object | A device object | **Example** ```js resin.models.device.get('7cf02a6').then(function(device) { resin.models.device.lastOnline(device); }) ``` #### models.apiKey : object **Kind**: static namespace of [models](#resin.models) * [.apiKey](#resin.models.apiKey) : object * [.create(name, [description])](#resin.models.apiKey.create) ⇒ Promise * [.getAll([options])](#resin.models.apiKey.getAll) ⇒ Promise * [.update(id, apiKeyInfo)](#resin.models.apiKey.update) ⇒ Promise * [.revoke(id)](#resin.models.apiKey.revoke) ⇒ Promise ##### apiKey.create(name, [description]) ⇒ Promise This method registers a new api key for the current user with the name given. **Kind**: static method of [apiKey](#resin.models.apiKey) **Summary**: Creates a new user API key **Access**: public **Fulfil**: String - API key | Param | Type | Default | Description | | --- | --- | --- | --- | | name | String | | the API key name | | [description] | String | | the API key description | **Example** ```js resin.models.apiKey.create(apiKeyName).then(function(apiKey) { console.log(apiKey); }); ``` **Example** ```js resin.models.apiKey.create(apiKeyName, apiKeyDescription).then(function(apiKey) { console.log(apiKey); }); ``` **Example** ```js resin.models.apiKey.create(apiKeyName, function(error, apiKey) { if (error) throw error; console.log(apiKey); }); ``` ##### apiKey.getAll([options]) ⇒ Promise **Kind**: static method of [apiKey](#resin.models.apiKey) **Summary**: Get all API keys **Access**: public **Fulfil**: Object[] - apiKeys | Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.apiKey.getAll().then(function(apiKeys) { console.log(apiKeys); }); ``` **Example** ```js resin.models.apiKey.getAll(function(error, apiKeys) { if (error) throw error; console.log(apiKeys); }); ``` ##### apiKey.update(id, apiKeyInfo) ⇒ Promise **Kind**: static method of [apiKey](#resin.models.apiKey) **Summary**: Update the details of an API key **Access**: public | Param | Type | Description | | --- | --- | --- | | id | Number | API key id | | apiKeyInfo | Object | an object with the updated name or description | **Example** ```js resin.models.apiKey.update(123, { name: 'updatedName' }); ``` **Example** ```js resin.models.apiKey.update(123, { description: 'updated description' }); ``` **Example** ```js resin.models.apiKey.update(123, { name: 'updatedName', description: 'updated description' }); ``` **Example** ```js resin.models.apiKey.update(123, { name: 'updatedName', description: 'updated description' }, function(error, apiKeys) { if (error) throw error; console.log(apiKeys); }); ``` ##### apiKey.revoke(id) ⇒ Promise **Kind**: static method of [apiKey](#resin.models.apiKey) **Summary**: Revoke an API key **Access**: public | Param | Type | Description | | --- | --- | --- | | id | Number | API key id | **Example** ```js resin.models.apiKey.revoke(123); ``` **Example** ```js resin.models.apiKey.revoke(123, function(error) { if (error) throw error; }); ``` #### models.key : object **Kind**: static namespace of [models](#resin.models) * [.key](#resin.models.key) : object * [.getAll([options])](#resin.models.key.getAll) ⇒ Promise * [.get(id)](#resin.models.key.get) ⇒ Promise * [.remove(id)](#resin.models.key.remove) ⇒ Promise * [.create(title, key)](#resin.models.key.create) ⇒ Promise ##### key.getAll([options]) ⇒ Promise **Kind**: static method of [key](#resin.models.key) **Summary**: Get all ssh keys **Access**: public **Fulfil**: Object[] - ssh keys | Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.key.getAll().then(function(keys) { console.log(keys); }); ``` **Example** ```js resin.models.key.getAll(function(error, keys) { if (error) throw error; console.log(keys); }); ``` ##### key.get(id) ⇒ Promise **Kind**: static method of [key](#resin.models.key) **Summary**: Get a single ssh key **Access**: public **Fulfil**: Object - ssh key | Param | Type | Description | | --- | --- | --- | | id | String \| Number | key id | **Example** ```js resin.models.key.get(51).then(function(key) { console.log(key); }); ``` **Example** ```js resin.models.key.get(51, function(error, key) { if (error) throw error; console.log(key); }); ``` ##### key.remove(id) ⇒ Promise **Kind**: static method of [key](#resin.models.key) **Summary**: Remove ssh key **Access**: public | Param | Type | Description | | --- | --- | --- | | id | String \| Number | key id | **Example** ```js resin.models.key.remove(51); ``` **Example** ```js resin.models.key.remove(51, function(error) { if (error) throw error; }); ``` ##### key.create(title, key) ⇒ Promise **Kind**: static method of [key](#resin.models.key) **Summary**: Create a ssh key **Access**: public **Fulfil**: Object - ssh key | Param | Type | Description | | --- | --- | --- | | title | String | key title | | key | String | the public ssh key | **Example** ```js resin.models.key.create('Main', 'ssh-rsa AAAAB....').then(function(key) { console.log(key); }); ``` **Example** ```js resin.models.key.create('Main', 'ssh-rsa AAAAB....', function(error, key) { if (error) throw error; console.log(key); }); ``` #### models.os : object **Kind**: static namespace of [models](#resin.models) * [.os](#resin.models.os) : object * [.getDownloadSize(deviceType, [version])](#resin.models.os.getDownloadSize) ⇒ Promise * [.getSupportedVersions(deviceType)](#resin.models.os.getSupportedVersions) ⇒ Promise * [.getMaxSatisfyingVersion(deviceType, versionOrRange)](#resin.models.os.getMaxSatisfyingVersion) ⇒ Promise * [.getLastModified(deviceType, [version])](#resin.models.os.getLastModified) ⇒ Promise * [.download(deviceType, [version])](#resin.models.os.download) ⇒ Promise * [.getConfig(nameOrId, options)](#resin.models.os.getConfig) ⇒ Promise ##### os.getDownloadSize(deviceType, [version]) ⇒ Promise **Note!** Currently only the raw (uncompressed) size is reported. **Kind**: static method of [os](#resin.models.os) **Summary**: Get OS download size estimate **Access**: public **Fulfil**: Number - OS image download size, in bytes. | Param | Type | Description | | --- | --- | --- | | deviceType | String | device type slug | | [version] | String | semver-compatible version or 'latest', defaults to 'latest'. The version **must** be the exact version number. | **Example** ```js resin.models.os.getDownloadSize('raspberry-pi').then(function(size) { console.log('The OS download size for raspberry-pi', size); }); resin.models.os.getDownloadSize('raspberry-pi', function(error, size) { if (error) throw error; console.log('The OS download size for raspberry-pi', size); }); ``` ##### os.getSupportedVersions(deviceType) ⇒ Promise **Kind**: static method of [os](#resin.models.os) **Summary**: Get OS supported versions **Access**: public **Fulfil**: Object - the versions information, of the following structure: * versions - an array of strings, containing exact version numbers supported by the current environment * recommended - the recommended version, i.e. the most recent version that is _not_ pre-release, can be `null` * latest - the most recent version, including pre-releases * default - recommended (if available) or latest otherwise | Param | Type | Description | | --- | --- | --- | | deviceType | String | device type slug | **Example** ```js resin.models.os.getSupportedVersions('raspberry-pi').then(function(osVersions) { console.log('Supported OS versions for raspberry-pi', osVersions); }); resin.models.os.getSupportedVersions('raspberry-pi', function(error, osVersions) { if (error) throw error; console.log('Supported OS versions for raspberry-pi', osVersions); }); ``` ##### os.getMaxSatisfyingVersion(deviceType, versionOrRange) ⇒ Promise **Kind**: static method of [os](#resin.models.os) **Summary**: Get the max OS version satisfying the given range **Access**: public **Fulfil**: String\|null - the version number, or `null` if no matching versions are found | Param | Type | Description | | --- | --- | --- | | deviceType | String | device type slug | | versionOrRange | String | can be one of * the exact version number, in which case it is returned if the version is supported, or `null` is returned otherwise, * a [semver](https://www.npmjs.com/package/semver)-compatible range specification, in which case the most recent satisfying version is returned if it exists, or `null` is returned, * `'latest'` in which case the most recent version is returned, including pre-releases, * `'recommended'` in which case the recommended version is returned, i.e. the most recent version excluding pre-releases, which can be `null` if only pre-release versions are available, * `'default'` in which case the recommended version is returned if available, or `latest` is returned otherwise. Defaults to `'latest'`. | **Example** ```js resin.models.os.getSupportedVersions('raspberry-pi').then(function(osVersions) { console.log('Supported OS versions for raspberry-pi', osVersions); }); resin.models.os.getSupportedVersions('raspberry-pi', function(error, osVersions) { if (error) throw error; console.log('Supported OS versions for raspberry-pi', osVersions); }); ``` ##### os.getLastModified(deviceType, [version]) ⇒ Promise **Kind**: static method of [os](#resin.models.os) **Summary**: Get the OS image last modified date **Access**: public **Fulfil**: Date - last modified date | Param | Type | Description | | --- | --- | --- | | deviceType | String | device type slug | | [version] | String | semver-compatible version or 'latest', defaults to 'latest'. Unsupported (unpublished) version will result in rejection. The version **must** be the exact version number. To resolve the semver-compatible range use `resin.model.os.getMaxSatisfyingVersion`. | **Example** ```js resin.models.os.getLastModified('raspberry-pi').then(function(date) { console.log('The raspberry-pi image was last modified in ' + date); }); resin.models.os.getLastModified('raspberrypi3', '2.0.0').then(function(date) { console.log('The raspberry-pi image was last modified in ' + date); }); resin.models.os.getLastModified('raspberry-pi', function(error, date) { if (error) throw error; console.log('The raspberry-pi image was last modified in ' + date); }); ``` ##### os.download(deviceType, [version]) ⇒ Promise **Kind**: static method of [os](#resin.models.os) **Summary**: Download an OS image **Access**: public **Fulfil**: ReadableStream - download stream | Param | Type | Description | | --- | --- | --- | | deviceType | String | device type slug | | [version] | String | semver-compatible version or 'latest', defaults to 'latest' Unsupported (unpublished) version will result in rejection. The version **must** be the exact version number. To resolve the semver-compatible range use `resin.model.os.getMaxSatisfyingVersion`. | **Example** ```js resin.models.os.download('raspberry-pi').then(function(stream) { stream.pipe(fs.createWriteStream('foo/bar/image.img')); }); resin.models.os.download('raspberry-pi', function(error, stream) { if (error) throw error; stream.pipe(fs.createWriteStream('foo/bar/image.img')); }); ``` ##### os.getConfig(nameOrId, options) ⇒ Promise Builds the config.json for a device in the given application, with the given options. Note that an OS version is required. For versions < 2.7.8, config generation is only supported when using a session token, not an API key. **Kind**: static method of [os](#resin.models.os) **Summary**: Get an applications config.json **Access**: public **Fulfil**: Object - application configuration as a JSON object. | Param | Type | Default | Description | | --- | --- | --- | --- | | nameOrId | String \| Number | | application name (string) or id (number). | | options | Object | | OS configuration options to use. | | options.version | String | | Required: the OS version of the image. | | [options.network] | String | 'ethernet' | The network type that the device will use, one of 'ethernet' or 'wifi'. | | [options.appUpdatePollInterval] | Number | | How often the OS checks for updates, in minutes. | | [options.wifiKey] | String | | The key for the wifi network the device will connect to. | | [options.wifiSsid] | String | | The ssid for the wifi network the device will connect to. | | [options.ip] | String | | static ip address. | | [options.gateway] | String | | static ip gateway. | | [options.netmask] | String | | static ip netmask. | **Example** ```js resin.models.os.getConfig('MyApp', { version: ''2.12.7+rev1.prod'' }).then(function(config) { fs.writeFile('foo/bar/config.json', JSON.stringify(config)); }); resin.models.os.getConfig(123, { version: ''2.12.7+rev1.prod'' }).then(function(config) { fs.writeFile('foo/bar/config.json', JSON.stringify(config)); }); resin.models.os.getConfig('MyApp', { version: ''2.12.7+rev1.prod'' }, function(error, config) { if (error) throw error; fs.writeFile('foo/bar/config.json', JSON.stringify(config)); }); ``` #### models.config : object **Kind**: static namespace of [models](#resin.models) * [.config](#resin.models.config) : object * [.getAll()](#resin.models.config.getAll) ⇒ Promise * [.getDeviceTypes()](#resin.models.config.getDeviceTypes) ⇒ Promise * [.getDeviceOptions(deviceType)](#resin.models.config.getDeviceOptions) ⇒ Promise ##### config.getAll() ⇒ Promise **Kind**: static method of [config](#resin.models.config) **Summary**: Get all configuration **Access**: public **Fulfil**: Object - configuration **Example** ```js resin.models.config.getAll().then(function(config) { console.log(config); }); ``` **Example** ```js resin.models.config.getAll(function(error, config) { if (error) throw error; console.log(config); }); ``` ##### config.getDeviceTypes() ⇒ Promise **Kind**: static method of [config](#resin.models.config) **Summary**: Get device types **Access**: public **Fulfil**: Object[] - device types **Example** ```js resin.models.config.getDeviceTypes().then(function(deviceTypes) { console.log(deviceTypes); }); ``` **Example** ```js resin.models.config.getDeviceTypes(function(error, deviceTypes) { if (error) throw error; console.log(deviceTypes); }) ``` ##### config.getDeviceOptions(deviceType) ⇒ Promise **Kind**: static method of [config](#resin.models.config) **Summary**: Get configuration/initialization options for a device type **Access**: public **Fulfil**: Object[] - configuration options | Param | Type | Description | | --- | --- | --- | | deviceType | String | device type slug | **Example** ```js resin.models.config.getDeviceOptions('raspberry-pi').then(function(options) { console.log(options); }); ``` **Example** ```js resin.models.config.getDeviceOptions('raspberry-pi', function(error, options) { if (error) throw error; console.log(options); }); ``` #### models.release : object **Kind**: static namespace of [models](#resin.models) * [.release](#resin.models.release) : object * [.tags](#resin.models.release.tags) : object * [.getAllByApplication(nameOrId, [options])](#resin.models.release.tags.getAllByApplication) ⇒ Promise * [.getAllByRelease(id, [options])](#resin.models.release.tags.getAllByRelease) ⇒ Promise * [.getAll([options])](#resin.models.release.tags.getAll) ⇒ Promise * [.set(releaseId, tagKey, value)](#resin.models.release.tags.set) ⇒ Promise * [.remove(releaseId, tagKey)](#resin.models.release.tags.remove) ⇒ Promise * [.get(id, [options])](#resin.models.release.get) ⇒ Promise * [.getWithImageDetails(id, [options])](#resin.models.release.getWithImageDetails) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.release.getAllByApplication) ⇒ Promise ##### release.tags : object **Kind**: static namespace of [release](#resin.models.release) * [.tags](#resin.models.release.tags) : object * [.getAllByApplication(nameOrId, [options])](#resin.models.release.tags.getAllByApplication) ⇒ Promise * [.getAllByRelease(id, [options])](#resin.models.release.tags.getAllByRelease) ⇒ Promise * [.getAll([options])](#resin.models.release.tags.getAll) ⇒ Promise * [.set(releaseId, tagKey, value)](#resin.models.release.tags.set) ⇒ Promise * [.remove(releaseId, tagKey)](#resin.models.release.tags.remove) ⇒ Promise ###### tags.getAllByApplication(nameOrId, [options]) ⇒ Promise **Kind**: static method of [tags](#resin.models.release.tags) **Summary**: Get all release tags for an application **Access**: public **Fulfil**: Object[] - release tags | Param | Type | Default | Description | | --- | --- | --- | --- | | nameOrId | String \| Number | | application name (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.release.tags.getAllByApplication('MyApp').then(function(tags) { console.log(tags); }); ``` **Example** ```js resin.models.release.tags.getAllByApplication(999999).then(function(tags) { console.log(tags); }); ``` **Example** ```js resin.models.release.tags.getAllByApplication('MyApp', function(error, tags) { if (error) throw error; console.log(tags) }); ``` ###### tags.getAllByRelease(id, [options]) ⇒ Promise **Kind**: static method of [tags](#resin.models.release.tags) **Summary**: Get all release tags for a release **Access**: public **Fulfil**: Object[] - release tags | Param | Type | Default | Description | | --- | --- | --- | --- | | id | Number | | release id | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.release.tags.getAllByRelease(123).then(function(tags) { console.log(tags); }); ``` **Example** ```js resin.models.release.tags.getAllByRelease(123, function(error, tags) { if (error) throw error; console.log(tags) }); ``` ###### tags.getAll([options]) ⇒ Promise **Kind**: static method of [tags](#resin.models.release.tags) **Summary**: Get all release tags **Access**: public **Fulfil**: Object[] - release tags | Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.release.tags.getAll().then(function(tags) { console.log(tags); }); ``` **Example** ```js resin.models.release.tags.getAll(function(error, tags) { if (error) throw error; console.log(tags) }); ``` ###### tags.set(releaseId, tagKey, value) ⇒ Promise **Kind**: static method of [tags](#resin.models.release.tags) **Summary**: Set a release tag **Access**: public | Param | Type | Description | | --- | --- | --- | | releaseId | Number | release id | | tagKey | String | tag key | | value | String \| undefined | tag value | **Example** ```js resin.models.release.tags.set(123, 'EDITOR', 'vim'); ``` **Example** ```js resin.models.release.tags.set(123, 'EDITOR', 'vim', function(error) { if (error) throw error; }); ``` ###### tags.remove(releaseId, tagKey) ⇒ Promise **Kind**: static method of [tags](#resin.models.release.tags) **Summary**: Remove a release tag **Access**: public | Param | Type | Description | | --- | --- | --- | | releaseId | Number | release id | | tagKey | String | tag key | **Example** ```js resin.models.release.tags.remove(123, 'EDITOR'); ``` **Example** ```js resin.models.release.tags.remove(123, 'EDITOR', function(error) { if (error) throw error; }); ``` ##### release.get(id, [options]) ⇒ Promise **Kind**: static method of [release](#resin.models.release) **Summary**: Get a specific release **Access**: public **Fulfil**: Object - release | Param | Type | Default | Description | | --- | --- | --- | --- | | id | Number | | release id | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.release.get(123).then(function(release) { console.log(release); }); ``` **Example** ```js resin.models.release.get(123, function(error, release) { if (error) throw error; console.log(release); }); ``` ##### release.getWithImageDetails(id, [options]) ⇒ Promise This method does not map exactly to the underlying model: it runs a larger prebuilt query, and reformats it into an easy to use and understand format. If you want significantly more control, or to see the raw model directly, use `release.get(id, options)` instead. **Kind**: static method of [release](#resin.models.release) **Summary**: Get a specific release with the details of the images built **Access**: public **Fulfil**: Object - release with image details | Param | Type | Default | Description | | --- | --- | --- | --- | | id | Number | | release id | | [options] | Object | {} | a map of extra pine options | | [options.release] | Boolean | {} | extra pine options for releases | | [options.image] | Object | {} | extra pine options for images | **Example** ```js resin.models.release.getWithImageDetails(123).then(function(release) { console.log(release); }); ``` **Example** ```js resin.models.release.getWithImageDetails(123, { image: { $select: 'build_log' } }) .then(function(release) { console.log(release.images[0].build_log); }); ``` **Example** ```js resin.models.release.getWithImageDetails(123, function(error, release) { if (error) throw error; console.log(release); }); ``` ##### release.getAllByApplication(nameOrId, [options]) ⇒ Promise **Kind**: static method of [release](#resin.models.release) **Summary**: Get all releases from an application **Access**: public **Fulfil**: Object[] - releases | Param | Type | Default | Description | | --- | --- | --- | --- | | nameOrId | String \| Number | | application name (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.release.getAllByApplication('MyApp').then(function(releases) { console.log(releases); }); ``` **Example** ```js resin.models.release.getAllByApplication(123).then(function(releases) { console.log(releases); }); ``` **Example** ```js resin.models.release.getAllByApplication('MyApp', function(error, releases) { if (error) throw error; console.log(releases); }); ``` #### models.service : object **Kind**: static namespace of [models](#resin.models) * [.service](#resin.models.service) : object * [.var](#resin.models.service.var) : object * [.getAllByService(id, [options])](#resin.models.service.var.getAllByService) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.service.var.getAllByApplication) ⇒ Promise * [.get(id, key)](#resin.models.service.var.get) ⇒ Promise * [.set(id, key, value)](#resin.models.service.var.set) ⇒ Promise * [.remove(id, key)](#resin.models.service.var.remove) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.service.getAllByApplication) ⇒ Promise ##### service.var : object **Kind**: static namespace of [service](#resin.models.service) * [.var](#resin.models.service.var) : object * [.getAllByService(id, [options])](#resin.models.service.var.getAllByService) ⇒ Promise * [.getAllByApplication(nameOrId, [options])](#resin.models.service.var.getAllByApplication) ⇒ Promise * [.get(id, key)](#resin.models.service.var.get) ⇒ Promise * [.set(id, key, value)](#resin.models.service.var.set) ⇒ Promise * [.remove(id, key)](#resin.models.service.var.remove) ⇒ Promise ###### var.getAllByService(id, [options]) ⇒ Promise **Kind**: static method of [var](#resin.models.service.var) **Summary**: Get all variables for a service **Access**: public **Fulfil**: Object[] - service variables | Param | Type | Default | Description | | --- | --- | --- | --- | | id | Number | | service id | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.service.var.getAllByService(999999).then(function(vars) { console.log(vars); }); ``` **Example** ```js resin.models.service.var.getAllByService(999999, function(error, vars) { if (error) throw error; console.log(vars) }); ``` ###### var.getAllByApplication(nameOrId, [options]) ⇒ Promise **Kind**: static method of [var](#resin.models.service.var) **Summary**: Get all service variables by application **Access**: public **Fulfil**: Object[] - service variables | Param | Type | Default | Description | | --- | --- | --- | --- | | nameOrId | String \| Number | | application name (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.service.var.getAllByApplication('MyApp').then(function(vars) { console.log(vars); }); ``` **Example** ```js resin.models.service.var.getAllByApplication(999999).then(function(vars) { console.log(vars); }); ``` **Example** ```js resin.models.service.var.getAllByApplication('MyApp', function(error, vars) { if (error) throw error; console.log(vars) }); ``` ###### var.get(id, key) ⇒ Promise **Kind**: static method of [var](#resin.models.service.var) **Summary**: Get the value of a specific service variable **Access**: public **Fulfil**: String\|undefined - the variable value (or undefined) | Param | Type | Description | | --- | --- | --- | | id | Number | service id | | key | String | variable name | **Example** ```js resin.models.service.var.get(999999, 'VAR').then(function(value) { console.log(value); }); ``` **Example** ```js resin.models.service.var.get(999999, 'VAR', function(error, value) { if (error) throw error; console.log(value) }); ``` ###### var.set(id, key, value) ⇒ Promise **Kind**: static method of [var](#resin.models.service.var) **Summary**: Set the value of a specific service variable **Access**: public | Param | Type | Description | | --- | --- | --- | | id | Number | service id | | key | String | variable name | | value | String | variable value | **Example** ```js resin.models.service.var.set(999999, 'VAR', 'newvalue').then(function() { ... }); ``` **Example** ```js resin.models.service.var.set(999999, 'VAR', 'newvalue', function(error) { if (error) throw error; ... }); ``` ###### var.remove(id, key) ⇒ Promise **Kind**: static method of [var](#resin.models.service.var) **Summary**: Clear the value of a specific service variable **Access**: public | Param | Type | Description | | --- | --- | --- | | id | Number | service id | | key | String | variable name | **Example** ```js resin.models.service.var.remove(999999, 'VAR').then(function() { ... }); ``` **Example** ```js resin.models.service.var.remove(999999, 'VAR', function(error) { if (error) throw error; ... }); ``` ##### service.getAllByApplication(nameOrId, [options]) ⇒ Promise **Kind**: static method of [service](#resin.models.service) **Summary**: Get all services from an application **Access**: public **Fulfil**: Object[] - services | Param | Type | Default | Description | | --- | --- | --- | --- | | nameOrId | String \| Number | | application name (string) or id (number) | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.service.getAllByApplication('MyApp').then(function(services) { console.log(services); }); ``` **Example** ```js resin.models.service.getAllByApplication(123).then(function(services) { console.log(services); }); ``` **Example** ```js resin.models.service.getAllByApplication('MyApp', function(error, services) { if (error) throw error; console.log(services); }); ``` #### models.image : object **Kind**: static namespace of [models](#resin.models) * [.image](#resin.models.image) : object * [.get(id, [options])](#resin.models.image.get) ⇒ Promise * [.getLogs(id)](#resin.models.image.getLogs) ⇒ Promise ##### image.get(id, [options]) ⇒ Promise **Kind**: static method of [image](#resin.models.image) **Summary**: Get a specific image **Access**: public **Fulfil**: Object - image | Param | Type | Default | Description | | --- | --- | --- | --- | | id | Number | | image id | | [options] | Object | {} | extra pine options to use | **Example** ```js resin.models.image.get(123).then(function(image) { console.log(image); }); ``` **Example** ```js resin.models.image.get(123, function(error, image) { if (error) throw error; console.log(image); }); ``` ##### image.getLogs(id) ⇒ Promise **Kind**: static method of [image](#resin.models.image) **Summary**: Get the logs for an image **Access**: public **Fulfil**: string - logs | Param | Type | Description | | --- | --- | --- | | id | Number | image id | **Example** ```js resin.models.image.getLogs(123).then(function(logs) { console.log(logs); }); ``` **Example** ```js resin.models.image.getLogs(123, function(error, logs) { if (error) throw error; console.log(logs); }); ``` #### models.billing : object **Note!** The billing methods are available on Resin.io exclusively. **Kind**: static namespace of [models](#resin.models) * [.billing](#resin.models.billing) : object * [.getAccount()](#resin.models.billing.getAccount) ⇒ Promise * [.getPlan()](#resin.models.billing.getPlan) ⇒ Promise * [.getBillingInfo()](#resin.models.billing.getBillingInfo) ⇒ Promise * [.updateBillingInfo()](#resin.models.billing.updateBillingInfo) ⇒ Promise * [.getInvoices()](#resin.models.billing.getInvoices) ⇒ Promise * [.downloadInvoice()](#resin.models.billing.downloadInvoice) ⇒ Promise ##### billing.getAccount() ⇒ Promise **Kind**: static method of [billing](#resin.models.billing) **Summary**: Get the user's billing account **Access**: public **Fulfil**: Object - billing account **Example** ```js resin.models.billing.getAccount().then(function(billingAccount) { console.log(billingAccount); }); ``` **Example** ```js resin.models.billing.getAccount(function(error, billingAccount) { if (error) throw error; console.log(billingAccount); }); ``` ##### billing.getPlan() ⇒ Promise **Kind**: static method of [billing](#resin.models.billing) **Summary**: Get the current billing plan **Access**: public **Fulfil**: Object - billing plan **Example** ```js resin.models.billing.getPlan().then(function(billingPlan) { console.log(billingPlan); }); ``` **Example** ```js resin.models.billing.getPlan(function(error, billingPlan) { if (error) throw error; console.log(billingPlan); }); ``` ##### billing.getBillingInfo() ⇒ Promise **Kind**: static method of [billing](#resin.models.billing) **Summary**: Get the current billing information **Access**: public **Fulfil**: Object - billing information **Example** ```js resin.models.billing.getBillingInfo().then(function(billingInfo) { console.log(billingInfo); }); ``` **Example** ```js resin.models.billing.getBillingInfo(function(error, billingInfo) { if (error) throw error; console.log(billingInfo); }); ``` ##### billing.updateBillingInfo() ⇒ Promise **Kind**: static method of [billing](#resin.models.billing) **Summary**: Update the current billing information **Access**: public **Fulfil**: Object - billing information | Type | Description | | --- | --- | | Object | an object containing a billing info token_id | **Example** ```js resin.models.billing.updateBillingInfo({ token_id: 'xxxxxxx' }).then(function(billingInfo) { console.log(billingInfo); }); ``` **Example** ```js resin.models.billing.updateBillingInfo({ token_id: 'xxxxxxx' }, function(error, billingInfo) { if (error) throw error; console.log(billingInfo); }); ``` ##### billing.getInvoices() ⇒ Promise **Kind**: static method of [billing](#resin.models.billing) **Summary**: Get the available invoices **Access**: public **Fulfil**: Object - invoices **Example** ```js resin.models.billing.getInvoices().then(function(invoices) { console.log(invoices); }); ``` **Example** ```js resin.models.billing.getInvoices(function(error, invoices) { if (error) throw error; console.log(invoices); }); ``` ##### billing.downloadInvoice() ⇒ Promise **Kind**: static method of [billing](#resin.models.billing) **Summary**: Download a specific invoice **Access**: public **Fulfil**: Blob\|ReadableStream - blob on the browser, download stream on node | Type | Description | | --- | --- | | String | an invoice number | **Example** ```js # Browser resin.models.billing.downloadInvoice('0000').then(function(blob) { console.log(blob); }); # Node resin.models.billing.downloadInvoice('0000').then(function(stream) { stream.pipe(fs.createWriteStream('foo/bar/invoice-0000.pdf')); }); ``` ### resin.auth : object **Kind**: static namespace of [resin](#resin) * [.auth](#resin.auth) : object * [.twoFactor](#resin.auth.twoFactor) : object * [.isEnabled()](#resin.auth.twoFactor.isEnabled) ⇒ Promise * [.isPassed()](#resin.auth.twoFactor.isPassed) ⇒ Promise * [.challenge(code)](#resin.auth.twoFactor.challenge) ⇒ Promise * [.whoami()](#resin.auth.whoami) ⇒ Promise * [.authenticate(credentials)](#resin.auth.authenticate) ⇒ Promise * [.login(credentials)](#resin.auth.login) ⇒ Promise * [.loginWithToken(authToken)](#resin.auth.loginWithToken) ⇒ Promise * [.isLoggedIn()](#resin.auth.isLoggedIn) ⇒ Promise * [.getToken()](#resin.auth.getToken) ⇒ Promise * [.getUserId()](#resin.auth.getUserId) ⇒ Promise * [.getEmail()](#resin.auth.getEmail) ⇒ Promise * [.logout()](#resin.auth.logout) ⇒ Promise * [.register([credentials])](#resin.auth.register) ⇒ Promise #### auth.twoFactor : object **Kind**: static namespace of [auth](#resin.auth) * [.twoFactor](#resin.auth.twoFactor) : object * [.isEnabled()](#resin.auth.twoFactor.isEnabled) ⇒ Promise * [.isPassed()](#resin.auth.twoFactor.isPassed) ⇒ Promise * [.challenge(code)](#resin.auth.twoFactor.challenge) ⇒ Promise ##### twoFactor.isEnabled() ⇒ Promise **Kind**: static method of [twoFactor](#resin.auth.twoFactor) **Summary**: Check if two factor authentication is enabled **Access**: public **Fulfil**: Boolean - whether 2fa is enabled **Example** ```js resin.auth.twoFactor.isEnabled().then(function(isEnabled) { if (isEnabled) { console.log('2FA is enabled for this account'); } }); ``` **Example** ```js resin.auth.twoFactor.isEnabled(function(error, isEnabled) { if (error) throw error; if (isEnabled) { console.log('2FA is enabled for this account'); } }); ``` ##### twoFactor.isPassed() ⇒ Promise **Kind**: static method of [twoFactor](#resin.auth.twoFactor) **Summary**: Check if two factor authentication challenge was passed **Access**: public **Fulfil**: Boolean - whether 2fa challenge was passed **Example** ```js resin.auth.twoFactor.isPassed().then(function(isPassed) { if (isPassed) { console.log('2FA challenge passed'); } }); ``` **Example** ```js resin.auth.twoFactor.isPassed(function(error, isPassed) { if (error) throw error; if (isPassed) { console.log('2FA challenge passed'); } }); ``` ##### twoFactor.challenge(code) ⇒ Promise **Kind**: static method of [twoFactor](#resin.auth.twoFactor) **Summary**: Challenge two factor authentication **Access**: public | Param | Type | Description | | --- | --- | --- | | code | String | code | **Example** ```js resin.auth.twoFactor.challenge('1234'); ``` **Example** ```js resin.auth.twoFactor.challenge('1234', function(error) { if (error) throw error; }); ``` #### auth.whoami() ⇒ Promise This will only work if you used [module:resin.auth.login](module:resin.auth.login) to log in. **Kind**: static method of [auth](#resin.auth) **Summary**: Return current logged in username **Access**: public **Fulfil**: (String\|undefined) - username, if it exists **Example** ```js resin.auth.whoami().then(function(username) { if (!username) { console.log('I\'m not logged in!'); } else { console.log('My username is:', username); } }); ``` **Example** ```js resin.auth.whoami(function(error, username) { if (error) throw error; if (!username) { console.log('I\'m not logged in!'); } else { console.log('My username is:', username); } }); ``` #### auth.authenticate(credentials) ⇒ Promise You should use [module:resin.auth.login](module:resin.auth.login) when possible, as it takes care of saving the token and email as well. Notice that if `credentials` contains extra keys, they'll be discarted by the server automatically. **Kind**: static method of [auth](#resin.auth) **Summary**: Authenticate with the server **Access**: protected **Fulfil**: String - session token | Param | Type | Description | | --- | --- | --- | | credentials | Object | in the form of email, password | | credentials.email | String | the email | | credentials.password | String | the password | **Example** ```js resin.auth.authenticate(credentials).then(function(token) { console.log('My token is:', token); }); ``` **Example** ```js resin.auth.authenticate(credentials, function(error, token) { if (error) throw error; console.log('My token is:', token); }); ``` #### auth.login(credentials) ⇒ Promise If the login is successful, the token is persisted between sessions. **Kind**: static method of [auth](#resin.auth) **Summary**: Login to Resin.io **Access**: public | Param | Type | Description | | --- | --- | --- | | credentials | Object | in the form of email, password | | credentials.email | String | the email | | credentials.password | String | the password | **Example** ```js resin.auth.login(credentials); ``` **Example** ```js resin.auth.login(credentials, function(error) { if (error) throw error; }); ``` #### auth.loginWithToken(authToken) ⇒ Promise Login to resin with a session token or api key instead of with credentials. **Kind**: static method of [auth](#resin.auth) **Summary**: Login to Resin.io with a token or api key **Access**: public | Param | Type | Description | | --- | --- | --- | | authToken | String | the auth token | **Example** ```js resin.auth.loginWithToken(authToken); ``` **Example** ```js resin.auth.loginWithToken(authToken, function(error) { if (error) throw error; }); ``` #### auth.isLoggedIn() ⇒ Promise **Kind**: static method of [auth](#resin.auth) **Summary**: Check if you're logged in **Access**: public **Fulfil**: Boolean - is logged in **Example** ```js resin.auth.isLoggedIn().then(function(isLoggedIn) { if (isLoggedIn) { console.log('I\'m in!'); } else { console.log('Too bad!'); } }); ``` **Example** ```js resin.auth.isLoggedIn(function(error, isLoggedIn) { if (error) throw error; if (isLoggedIn) { console.log('I\'m in!'); } else { console.log('Too bad!'); } }); ``` #### auth.getToken() ⇒ Promise This will only work if you used [module:resin.auth.login](module:resin.auth.login) to log in. **Kind**: static method of [auth](#resin.auth) **Summary**: Get current logged in user's raw API key or session token **Access**: public **Fulfil**: String - raw API key or session token **Example** ```js resin.auth.getToken().then(function(token) { console.log(token); }); ``` **Example** ```js resin.auth.getToken(function(error, token) { if (error) throw error; console.log(token); }); ``` #### auth.getUserId() ⇒ Promise This will only work if you used [module:resin.auth.login](module:resin.auth.login) to log in. **Kind**: static method of [auth](#resin.auth) **Summary**: Get current logged in user's id **Access**: public **Fulfil**: Number - user id **Example** ```js resin.auth.getUserId().then(function(userId) { console.log(userId); }); ``` **Example** ```js resin.auth.getUserId(function(error, userId) { if (error) throw error; console.log(userId); }); ``` #### auth.getEmail() ⇒ Promise This will only work if you used [module:resin.auth.login](module:resin.auth.login) to log in. **Kind**: static method of [auth](#resin.auth) **Summary**: Get current logged in user's email **Access**: public **Fulfil**: String - user email **Example** ```js resin.auth.getEmail().then(function(email) { console.log(email); }); ``` **Example** ```js resin.auth.getEmail(function(error, email) { if (error) throw error; console.log(email); }); ``` #### auth.logout() ⇒ Promise **Kind**: static method of [auth](#resin.auth) **Summary**: Logout from Resin.io **Access**: public **Example** ```js resin.auth.logout(); ``` **Example** ```js resin.auth.logout(function(error) { if (error) throw error; }); ``` #### auth.register([credentials]) ⇒ Promise **Kind**: static method of [auth](#resin.auth) **Summary**: Register to Resin.io **Access**: public **Fulfil**: String - session token | Param | Type | Default | Description | | --- | --- | --- | --- | | [credentials] | Object | {} | in the form of username, password and email | | credentials.email | String | | the email | | credentials.password | String | | the password | **Example** ```js resin.auth.register({ email: 'johndoe@gmail.com', password: 'secret' }).then(function(token) { console.log(token); }); ``` **Example** ```js resin.auth.register({ email: 'johndoe@gmail.com', password: 'secret' }, function(error, token) { if (error) throw error; console.log(token); }); ``` ### resin.logs : object **Kind**: static namespace of [resin](#resin) * [.logs](#resin.logs) : object * [.subscribe(uuidOrId, [options])](#resin.logs.subscribe) ⇒ Promise * [.history(uuidOrId, [options])](#resin.logs.history) ⇒ Promise * [.LogSubscription](#resin.logs.LogSubscription) : EventEmitter * [.unsubscribe()](#resin.logs.LogSubscription.unsubscribe) * ["line"](#resin.logs.LogSubscription.event_line) * ["error"](#resin.logs.LogSubscription.event_error) #### logs.subscribe(uuidOrId, [options]) ⇒ Promise Connects to the stream of devices logs, returning a LogSubscription, which can be used to listen for logs as they appear, line by line. **Kind**: static method of [logs](#resin.logs) **Summary**: Subscribe to device logs **Access**: public **Fulfil**: [LogSubscription](#resin.logs.LogSubscription) **Todo** - [ ] We should consider making this a readable stream. | Param | Type | Default | Description | | --- | --- | --- | --- | | uuidOrId | String \| Number | | device uuid (string) or id (number) | | [options] | Object | | options | | [options.count] | Number \| 'all' | 0 | number of historical messages to include (or 'all') | **Example** ```js resin.logs.subscribe('7cf02a6').then(function(logs) { logs.on('line', function(line) { console.log(line); }); }); ``` **Example** ```js resin.logs.subscribe(123).then(function(logs) { logs.on('line', function(line) { console.log(line); }); }); ``` **Example** ```js resin.logs.subscribe('7cf02a6', function(error, logs) { if (error) throw error; logs.on('line', function(line) { console.log(line); }); }); ``` #### logs.history(uuidOrId, [options]) ⇒ Promise Get an array of the latest log messages for a given device. **Kind**: static method of [logs](#resin.logs) **Summary**: Get device logs history **Access**: public **Fulfil**: Object[] - history lines | Param | Type | Default | Description | | --- | --- | --- | --- | | uuidOrId | String \| Number | | device uuid (string) or id (number) | | [options] | Object | | options | | [options.count] | Number \| 'all' | 1000 | number of log messages to return (or 'all') | **Example** ```js resin.logs.history('7cf02a6').then(function(lines) { lines.forEach(function(line) { console.log(line); }); }); ``` **Example** ```js resin.logs.history(123).then(function(lines) { lines.forEach(function(line) { console.log(line); }); }); ``` **Example** ```js resin.logs.history('7cf02a6', { count: 20 }, function(error, lines) { if (error) throw error; lines.forEach(function(line) { console.log(line); }); }); ``` #### logs.LogSubscription : EventEmitter The log subscription emits events as log data arrives. You can get a LogSubscription for a given device by calling `resin.logs.subscribe(deviceId)` **Kind**: static typedef of [logs](#resin.logs) * [.LogSubscription](#resin.logs.LogSubscription) : EventEmitter * [.unsubscribe()](#resin.logs.LogSubscription.unsubscribe) * ["line"](#resin.logs.LogSubscription.event_line) * ["error"](#resin.logs.LogSubscription.event_error) ##### LogSubscription.unsubscribe() Disconnect from the logs feed and stop receiving any future events on this emitter. **Kind**: static method of [LogSubscription](#resin.logs.LogSubscription) **Summary**: Unsubscribe from device logs **Access**: public **Example** ```js logs.unsubscribe(); ``` ##### "line" **Kind**: event emitted by [LogSubscription](#resin.logs.LogSubscription) **Summary**: Event fired when a new line of log output is available **Example** ```js logs.on('line', function(line) { console.log(line); }); ``` ##### "error" **Kind**: event emitted by [LogSubscription](#resin.logs.LogSubscription) **Summary**: Event fired when an error has occured reading the device logs **Example** ```js logs.on('error', function(error) { console.error(error); }); ``` ### resin.settings : object **Kind**: static namespace of [resin](#resin) * [.settings](#resin.settings) : object * [.get([key])](#resin.settings.get) ⇒ Promise * [.getAll()](#resin.settings.getAll) ⇒ Promise #### settings.get([key]) ⇒ Promise **Kind**: static method of [settings](#resin.settings) **Summary**: Get a single setting. **Only implemented in Node.js** **Access**: public **Fulfil**: \* - setting value | Param | Type | Description | | --- | --- | --- | | [key] | String | setting key | **Example** ```js resin.settings.get('apiUrl').then(function(apiUrl) { console.log(apiUrl); }); ``` **Example** ```js resin.settings.get('apiUrl', function(error, apiUrl) { if (error) throw error; console.log(apiUrl); }); ``` #### settings.getAll() ⇒ Promise **Kind**: static method of [settings](#resin.settings) **Summary**: Get all settings **Only implemented in Node.js** **Access**: public **Fulfil**: Object - settings **Example** ```js resin.settings.getAll().then(function(settings) { console.log(settings); }); ``` **Example** ```js resin.settings.getAll(function(error, settings) { if (error) throw error; console.log(settings); }); ``` ### resin.setSharedOptions() Set options that are used by calls to `resin.fromSharedOptions()`. The options accepted are the same as those used in the main SDK factory function. If you use this method, it should be called as soon as possible during app startup and before any calls to `fromSharedOptions()` are made. **Kind**: static method of [resin](#resin) **Summary**: Set shared default options **Access**: public **Params**: Object opts - The shared default options **Example** ```js resin.setSharedOptions({ apiUrl: 'https://api.resin.io/', imageMakerUrl: 'https://img.resin.io/', isBrowser: true, }); ``` ### resin.fromSharedOptions() Create an SDK instance using shared default options set using the `setSharedOptions()` method. If options have not been set using this method, then this method will use the same defaults as the main SDK factory function. **Kind**: static method of [resin](#resin) **Summary**: Create an SDK instance using shared default options **Access**: public **Params**: Object opts - The shared default options **Example** ```js const sdk = resin.fromSharedOptions(); ```