ubidots-javascript-library6

Ubidots Library

The Ubidots Library provides an intuitive and easy-to-use interface for interacting with the Ubidots API, enabling data sending, information visualization, and device management.

Usage

Here is an example of how to use the Ubidots library:

import Ubidots from '.@ubidots-library';
import Auth from '@ubidots-library/auth';

const run = async () => {
  // Authenticate with Ubidots API using a token
  await AuthInstance.authenticate('TOKEN');
  // Get a specific device by name
  const ubidotsDevice = await Ubidots.devices.where('name').is('ubidots-cli-device').first();
  // Get the first variable that starts with the name "ubidots"
  const ubidotsVariable = await ubidotsDevice.variables.where('label').startsWith('ubidots').first();
  // Send dots to the variable
  const response = await ubidotsVariable.sendDots([{ value: 12, timestamp: 123123131 }]);
};

run();

API

Ubidots.devices.paginate(limit, page)

Description: Returns a paginated list of devices in Ubidots as - entity (string): Name of the entity in the Ubidots API. instances.

• limit (number): The maximum number of devices per page.
• page (number): The page number to retrieve.

Ubidots.<entity>.where(<field>).<filter>(<value>)

Description: Allows filtered queries based on a specific field and its value.

• entity (string): Name of the entity in the Ubidots API.
• field (string): The field to filter on.
• filter (Filter): The filter condition to apply.
• value (any): The value to match in the field.

Ubidots.<entity>.all()

Description: Returns all the entities of a specific type.

• entity (string): Name of the entity in the Ubidots API.

Ubidots Objects

Ubidots Objects are the main interface for interacting with the Ubidots entities. They provide a set of methods to interact with them and their related entities, in addition to the capacity of update and delete them.

Each Ubidots Object provide all its properties as getters, so you can access them directly. Some properties are read-only, so, even if you try to update them, they will not be updated.

DeviceObject

DeviceObject.variables

Return all variables related with the device as VariableObject instance with the variables of the device.

VariableObject

VariableObject.sendDots(dots)

Description: Send dots to the variable.

Please refer to the official Ubidots API documentation for available filters per entity: Ubidots API Reference

License

The Ubidots library is distributed under the MIT License. See the LICENSE file for more information.