DocumentaciónEntrarCrear cuenta

Documentación / SDK / Node.js

Node.js

SDK de nube para Node.js 20 o superior, en ESM y CommonJS. Renueva la sesión ante un 401 y reintenta fallos de red, respuestas 429 y errores 5xx. Los errores de validación no se reintentan.

Instalación

Descargue ovenbird-node-1.0.0.tgz e instálelo en el servicio. El paquete no está en el registro público de npm.

npm install https://iotplatform.ovenbirdconsulting.com.ar/descargas/ovenbird-node-1.0.0.tgz
import { OvenbirdClient } from '@ovenbird/node';

const ob = new OvenbirdClient({
  baseUrl: process.env.OVENBIRD_URL,
  clientId: process.env.OVENBIRD_CLIENT_ID,
  clientSecret: process.env.OVENBIRD_CLIENT_SECRET,
});

const page = await ob.devices.list({ limit: 50 });
const status = await ob.devices.status(page.items[0].deviceId);
MétodoDescripción
devices.list / get / update / removeGestión de dispositivos.
devices.status / historyEstado actual e historial. history requiere dp.
commands.send / get / waitForAckEnvío y espera de confirmación.
events.subscribeReportes, conexión y comandos. Reanuda con Last-Event-ID.
pairing.createCodeCódigo de un solo uso, vigente 10 minutos.
embed.createTokenToken de aplicación, de 1 a 50 dispositivos.

NestJS

OvenbirdModule.forRoot registra OvenbirdService. También existe forRootAsync.

import { Module } from '@nestjs/common';
import { OvenbirdModule } from '@ovenbird/node/nest';

@Module({
  imports: [
    OvenbirdModule.forRoot({
      baseUrl: process.env.OVENBIRD_URL,
      clientId: process.env.OVENBIRD_CLIENT_ID,
      clientSecret: process.env.OVENBIRD_CLIENT_SECRET,
    }),
  ],
})
export class AppModule {}