@evops/lightwaverf 0.0.6 → 0.0.7

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2022 Evops Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,83 +1,3 @@
-node-lightwaverf
-================
-
-A NodeJS library for controlling devices using the LightwaveRF Wi-Fi Link
-
-## Installation
-
-    npm install lightwaverf
-
-## Usage
-
-### Initialize
-
-    var LightwaveRF = require("lightwaverf");
-    var lw = new LightwaveRF({ip:"192.168.1.123",email:"name@host.com",pin:"0123"});
-
-Or to read from a [LightwareRF Gem](https://github.com/pauly/lightwaverf) format YAML file:
-
-    var lw = new LightwaveRF({ip:"192.168.1.123", file:"/a/config/file.yml"});
-
-### Turn a device on
-
-To turn a device on you need to have set it up using the mobile or web app. You need the room ID and the device ID.
-
-    lw.turnDeviceOn(1 /*roomId*/, 1 /*deviceId*/, function(error, content) {
-        if (error) {
-            console.log("Error turning device on " + error.message);
-        } else {
-            console.log("Response: " + content);
-        }
-    });
-
-### Turn a device off
-
-To turn a device off you need to have set it up using the mobile or web app. You need the room ID and the device ID.
-
-    lw.turnDeviceOff(1 /*roomId*/, 1 /*deviceId*/, function(error, content) {
-        if (error) {
-            console.log("Error turning device off " + error.message);
-        } else {
-            console.log("Response: " + content);
-        }
-    });
-
-### Dim the device in a room
-
-To turn a dim the device in a room you need to have set it up using the mobile or web app. You need the room ID and device ID.
-
-    lw.setDeviceDim(1 /*roomId*/, 1 /*deviceId*/, 50 /*percentage from 0-100*/, function(error, content) {
-        if (error) {
-            console.log("Error changing dim of device " + error.message);
-        } else {
-            console.log("Response: " + content);
-        }
-    });
-
-### Turn a room off
-
-To turn a room off you need to have set it up using the mobile or web app. You need the room ID.
-
-    lw.turnRoomOff(1 /*roomId*/, function(error, content) {
-        if (error) {
-            console.log("Error turning room off " + error.message);
-        } else {
-            console.log("Response: " + content);
-        }
-    });
-
-### Request the energy status
-
-To get the current status from the LightwaveRF Energy Monitor Smart Meter you need to have linked it to the Wi-Fi Link first.
-
-    lw.requestEnergy(function(error, data) {
-        if (error) {
-            console.log("Error turning device off " + error.message);
-        } else {
-            //data: { current: 300, max: 620, today: 850, yesterday: 0 }
-            console.log("Energy ", data);
-        }
-    });
-
-
+# LightwaveRF client library
 
+Originally based on https://github.com/ollieparsley/node-lightwaverf

package/dist/index.d.ts

@@ -0,0 +1,159 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import dgram from 'dgram';
+declare class LightwaveRFConfiguration {
+    timeout?: number;
+    ip?: string;
+    file?: any;
+    host?: any;
+    email?: any;
+    pin?: any;
+}
+interface LightwaveRFDevice {
+    roomId: number;
+    deviceId: number;
+    roomName: string;
+    deviceName: string;
+    deviceType: string;
+}
+declare interface LightwaveRF {
+    on(event: 'deviceTurnedOn', listener: (roomId: number, deviceId: number) => void): this;
+    on(event: 'deviceTurnedOff', listener: (roomId: number, deviceId: number) => void): this;
+}
+/**
+ * LightwaveRF API
+ *
+ * @param object config The config
+ *
+ * An instance of the LightwaveRF API
+ */
+declare class LightwaveRF extends EventEmitter {
+    timeout: number;
+    queue: any;
+    ready: boolean;
+    awaitRegistrration: boolean;
+    currentTransactionNumber: number;
+    devices: Array<LightwaveRFDevice>;
+    messageCounter: number;
+    config: LightwaveRFConfiguration;
+    sendSocket: dgram.Socket;
+    receiveSocket: dgram.Socket;
+    responseListeners: Map<number, any>;
+    constructor(config: LightwaveRFConfiguration, callback: (config: any, error: any) => void);
+    stop(): void;
+    initialiseConfiguration(callback: (config: any, error: string) => void): void;
+    /**
+     * Register this device with the Wi-Fi Link
+     *
+     * @param Function callback The callback function
+     *
+     * @return void
+     */
+    register(callback: any): void;
+    /**
+     * Request energy
+     *
+     * @param Function callback The callback function
+     *
+     * @return void
+     */
+    requestEnergy(callback: any): void;
+    /**
+     * Turn a device off
+     *
+     * @param integer  roomId   The room ID
+     * @param integer  deviceId The device ID
+     * @param Function callback The callback for if there are any errors
+     *
+     * @return void
+     */
+    turnDeviceOff(roomId: string, deviceId: string, callback?: any): void;
+    /**
+     * Turn a device on
+     *
+     * @param integer  roomId   The room ID
+     * @param integer  deviceId The device ID
+     * @param Function callback The callback for if there are any errors
+     *
+     * @return void
+     */
+    turnDeviceOn(roomId: string, deviceId: string, callback?: any): void;
+    /**
+     * Open a device
+     *
+     * @param integer  roomId   The room ID
+     * @param integer  deviceId The device ID
+     * @param Function callback The callback for if there are any errors
+     *
+     * @return void
+     */
+    openDevice(roomId: string, deviceId: string, callback: any): void;
+    /**
+     * Close a device
+     *
+     * @param integer  roomId   The room ID
+     * @param integer  deviceId The device ID
+     * @param Function callback The callback for if there are any errors
+     *
+     * @return void
+     */
+    closeDevice(roomId: string, deviceId: string, callback: any): void;
+    /**
+     * Stop a device
+     *
+     * @param integer  roomId   The room ID
+     * @param integer  deviceId The device ID
+     * @param Function callback The callback for if there are any errors
+     *
+     * @return void
+     */
+    stopDevice(roomId: string, deviceId: string, callback: any): void;
+    /**
+     * Turn all devices in a room off
+     *
+     * @param integer  roomId   The room ID
+     * @param Function callback The callback for if there are any errors
+     *
+     * @return void
+     */
+    turnRoomOff(roomId: string, callback: any): void;
+    /**
+     * Set the dim percentage of a device
+     *
+     * @param integer  roomId        The room ID
+     * @param integer  deviceId      The device ID
+     * @param integer  dimPercentage The percentage to set the device dim
+     * @param Function callback      The callback for if there are any errors
+     *
+     * @return void
+     */
+    setDeviceDim(roomId: string, deviceId: string, dimPercentage: number, callback: any): void;
+    /**
+     * Get message code
+     *
+     * @return string
+     */
+    private getTransactionNumber;
+    private exec;
+    private send;
+    /**
+     * Send a message over udp
+     *
+     * @param string   message  The message to send
+     * @param Function callback The callback for if there are any errors
+     *
+     * @return void
+     */
+    private sendUdp;
+    private process;
+    /**
+     * Parser to get de devices from https POST
+     */
+    getDevices(roomsString: string, devicesString: string, typesString: string, callback: (object: any, lw: this) => void): void;
+    parseRooms(lightwaveResponse: any, callback: any): void;
+    /**
+     * Connect to the server and obtain the configuration
+     */
+    getConfiguration(email: string, pin: string, manager_host: string, callback: any): void;
+}
+export default LightwaveRF;