Getting started

Installation

For a new project

1. Initialize with Yarn or npm:

   yarn init
   # or
   npm init

2. Add the library to the project:

   npm i @ubidots/ubidots-javascript-library --save-dev
   # or
   yarn add @ubidots/ubidots-javascript-library -D

For existing projects

Go to the project's root directory and run:

npm i @ubidots/ubidots-javascript-library --save-dev
# or
yarn add @ubidots/ubidots-javascript-library -D

Importing the library

Depending on whether your project uses CommonJS or ES Modules, import the library as follows:

CommonJS

const { Ubidots } = require('@ubidots/ubidots-javascript-library');

ES Modules

import { Ubidots } from '@ubidots/ubidots-javascript-library';

Usage

// Uncomment to import the library using the correct syntax as outlined above
// const { Ubidots } = require('@ubidots/ubidots-javascript-library');
// or
// import { Ubidots } from '@ubidots/ubidots-javascript-library';

// Set custom domain
// Do not call this method if you want to use the default Ubidots host.
// Ubidots.setBaseUrl('custom-domain');

// Authenticate with the API
Ubidots.authenticate('<ubidots-token>');

// Get first 100 devices from the account
Ubidots.devices.get().then(devices => {
  // Prints an array of Device objects
  console.log(devices);

  // YOUR LOGIC OVER THESE 100 DEVICES
});

To use this SDK in the HTML Canvas widget, refer to its dedicated page.