obniz/dist/src/obniz/Obniz.js

obniz sdk for javascript

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Obniz = void 0;
const m5stack_basic_1 = require("./libs/hw/m5stack_basic");
const iekilo1_components_1 = require("./libs/hw/iekilo1_components");
const m5stickc_1 = require("./libs/hw/m5stickc");
const ObnizApi_1 = require("./ObnizApi");
const ObnizApp_1 = require("./ObnizApp");
const ObnizDevice_1 = require("./ObnizDevice");
const wscommand_1 = require("./libs/wscommand");
/**
 * obniz class is the abstract version of obniz Board hardware within JavaScript.
 *
 * By providing obniz id and instantiating it, you can control obniz Board and the connected parts
 * without the details of websocket api.
 *
 *
 * ### obnizOS version and obniz.js version
 *
 * obniz cloud compare your obniz.js version and target device obnizOS version.
 * If your js sdk major number is below from OS version (eg obniz.js is 2.0.0 and obnizOS is 3.0.0) then obniz cloud will alert when connection established.
 * It will work somehow but some functions looses compatibility.
 *
 * ### one device from two program
 *
 * obniz cloud accept multiple websocket connection from multiple obniz.js at same time.
 * every commands from obniz.js will passed to a device and every command from a device will be dispatched to every obniz.js connected to the cloud.
 *
 * But If one of obniz.js established a connection to a device, then target device will send datas only via local connect. So other connected obniz.js only can send datas and never receive datas from a device.
 *
 * If you'd like to receive, you need to specify `local_connect: false` at all of obniz.js to disable local connect.
 *
 */
class Obniz extends ObnizDevice_1.ObnizDevice {
    /**
     * obniz REST api class
     *
     * @returns {ObnizApi}
     */
    static get api() {
        return ObnizApi_1.ObnizApi;
    }
    /**
     * App Support class
     *
     * @returns {ObnizApp}
     */
    static get App() {
        return ObnizApp_1.ObnizApp;
    }
    static getWsCommandModule() {
        return (0, wscommand_1.createCommandManager)();
    }
}
exports.Obniz = Obniz;
/**
 * M5StickC device
 */
Obniz.M5StickC = m5stickc_1.M5StickC;
Obniz.M5StackBasic = m5stack_basic_1.M5StackBasic;
/**
 * types
 */
// eslint-disable-next-line no-redeclare
// eslint-disable-next-line @typescript-eslint/no-namespace
(function (Obniz) {
    // eslint-disable-next-line @typescript-eslint/no-unused-vars
    Obniz.KiloInterface = iekilo1_components_1.KiloInterface;
})(Obniz = exports.Obniz || (exports.Obniz = {}));