Resin-register-device NPM

resin-register-device

Resin.io device registration utilities.

Gitter (https://badges.gitter.im/Join Chat.svg)

Installation

Install resin-register-device by running:

$ npm install --save resin-register-device

Documentation

Resin-Register-Device exports a factory function, which must be called with a dependencies object, containing a configured resin-request instance.

Example:

deviceRegister = require('resin-register-device')({
	request: request # An instantiated resin-request instance
})

deviceRegister.generateUniqueKey()

Generate a random key, useful for both uuid and api key.

Example:

randomKey = deviceRegister.generateUniqueKey()
# randomKey is a randomly generated key that can be used as either a uuid or an api key
console.log(randomKey)

deviceRegister.register(Object options, Function callback)

Notice: You can use this function as a promise if you omit the callback argument.

The options object requires the following properties:

Number userId: The user id.
Number applicationId: The application id.
String uuid: The device's UUID.
String deviceType: The device type slug.
String deviceApiKey: The API key to create for the newly registered device.
String provisioningApiKey: The provisioning API Key.
String apiEndpoint: The API endpoint.

The callback gets called with two arguments: (error, deviceInfo), where deviceInfo is an object containing one property: the id for the device that was just registered.

Example:

deviceRegister.register
		userId: 199
		applicationId: 10350
		uuid: '...'
		deviceType: 'raspberry-pi'
		deviceApiKey: '...'
		provisioningApiKey: '...'
		apiEndpoint: 'https://api.resin.io'
	, (error, deviceInfo) ->
		throw error if error?
		console.log(deviceInfo) # { id }