@vldmit/leap-client 1.7.9

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Michael Kellsy
+
+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

@@ -0,0 +1,151 @@
+# Lutron LEAP Client
+
+Publishes devices, states and actions to an event emitter using the Lutron LEAP protocol.
+
+## API
+
+[**API Documentation**](docs/README.md)
+
+Pairing a processor or bridge
+
+```js
+import { pair } from "@mkellsy/leap-client";
+
+console.log("Press the pairing button on the main processor or smart bridge");
+
+await pair();
+```
+
+This will autopmatically discover processors. You will need to press the pairing button on your processor or bridge.
+
+If you have multiple systems Caseta and RA3, you can pair other processors or bridges by runnging the pair command again, and pressing the pairing button on the other device.
+
+> Systems that have more than one processor, such as RA3, you will only need to pair the first bridge. Devices programed for other bridges are vended from all processors.
+
+After you have a processor or bridge paired, you can connect.
+
+```js
+import { connect } from "@mkellsy/leap-client";
+
+const location = connect();
+
+location.on("Available", (processor): void => {
+    // event fired when all devices are available
+});
+
+location.on("Update", (device, state): void => {
+    // event fired when the device state updates
+});
+
+location.on("Action", (device, button, action): void => {
+    // event fired when a device action occurs
+});
+```
+
+> The processor will cache slow changing data, to refresh the areas, zones, remotes, etc... you can set the refresh flag when calling connect `connect(true)`.
+
+Fetch a list of processors.
+
+```js
+for (const id of location.processors) {
+    // the id is the processor id string
+}
+```
+
+Accessing the processor
+
+```js
+const processor = location.processor(id);
+```
+
+Pinging the a processor or bridge
+
+```js
+const response = await processor.ping();
+```
+
+Processor details.
+
+```js
+const system = await processor.system();
+const project = await processor.project();
+```
+
+Fetch a list of areas
+
+```js
+const areas = await processor.areas();
+```
+
+Fetch all statuses
+
+```js
+const statuses = await processor.statuses();
+```
+
+Fetch zones in an area
+
+```js
+const zones = await processor.zones(area);
+```
+
+Fetch a zone or area status
+
+```js
+const areaStatus = await processor.status(area);
+const zoneStatus = await processor.status(zone);
+```
+
+Fetch an area's controls
+
+```js
+const controls = await processor.controls(area);
+```
+
+Fetching ganged controls
+
+```js
+const controls = await processor.controls(area);
+
+for (const gangedDevice of control.AssociatedGangedDevices) {
+    const address = gangedDevice.Device;
+
+    // the the address can be used to fetch the pico remote, sensor, keypad
+}
+```
+
+Fetching a device
+
+```js
+const device = await processor.device(address);
+```
+
+Fetching a devices buttons
+
+```js
+const buttons = await processor.buttons(device);
+```
+
+Executing a command
+
+```js
+await processor.command(deviceOrZone, commandObject);
+```
+
+Fetching a discovered device
+
+```js
+const device = processor.devices.get(id);
+```
+
+Update the status of a device
+
+```js
+device.update(state);
+```
+
+Set a property(s) of a device
+
+```js
+device.set(state);
+```

package/lib/api.md

@@ -0,0 +1,176 @@
+## API Report File for "@vldmit/leap-client"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+/// <reference types="node" />
+
+import { Action } from '@mkellsy/hap-device';
+import { Address as Address_2 } from '@mkellsy/hap-device';
+import { AreaStatus as AreaStatus_2 } from '@mkellsy/hap-device';
+import { Button } from '@mkellsy/hap-device';
+import { Contact as Contact_2 } from '@mkellsy/hap-device';
+import { Device } from '@mkellsy/hap-device';
+import { DeviceState } from '@mkellsy/hap-device';
+import { Dimmer as Dimmer_2 } from '@mkellsy/hap-device';
+import { EventEmitter } from '@mkellsy/event-emitter';
+import { Fan as Fan_2 } from '@mkellsy/hap-device';
+import { ILogger } from 'js-logger';
+import { Keypad as Keypad_2 } from '@mkellsy/hap-device';
+import { Occupancy as Occupancy_2 } from '@mkellsy/hap-device';
+import { pki } from 'node-forge';
+import { Remote as Remote_2 } from '@mkellsy/hap-device';
+import { Shade as Shade_2 } from '@mkellsy/hap-device';
+import { Strip as Strip_2 } from '@mkellsy/hap-device';
+import { Switch as Switch_2 } from '@mkellsy/hap-device';
+import { Timeclock as Timeclock_2 } from '@mkellsy/hap-device';
+import { TimeclockStatus as TimeclockStatus_2 } from '@mkellsy/hap-device';
+import { Unknown as Unknown_2 } from '@mkellsy/hap-device';
+import { ZoneStatus as ZoneStatus_2 } from '@mkellsy/hap-device';
+
+// @public
+export class Client extends EventEmitter<{
+    Action: (device: Device, button: Button, action: Action) => void;
+    Available: (devices: Device[]) => void;
+    Message: (response: Response) => void;
+    Update: (device: Device, state: DeviceState) => void;
+}> {
+    constructor(refresh?: boolean);
+    close(): void;
+    // Warning: (ae-forgotten-export) The symbol "Processor" needs to be exported by the entry point index.d.ts
+    processor(id: string): Processor | undefined;
+    get processors(): string[];
+}
+
+// @public
+export function connect(refresh?: boolean): Client;
+
+// @public
+export interface Contact extends Contact_2 {
+    set(status: ContactState): Promise<void>;
+    readonly status: ContactState;
+    update(status: ZoneStatus_2): void;
+}
+
+// @public
+export interface ContactState extends DeviceState {
+    state: "Closed" | "Open";
+}
+
+// @public
+export interface Dimmer extends Dimmer_2 {
+    set(status: DimmerState): Promise<void>;
+    readonly status: DimmerState;
+    update(status: ZoneStatus_2): void;
+}
+
+// @public
+export interface DimmerState extends DeviceState {
+    level: number;
+    state: "On" | "Off";
+}
+
+// @public
+export interface Fan extends Fan_2 {
+    set(status: FanState): Promise<void>;
+    readonly status: FanState;
+    update(status: ZoneStatus_2): void;
+}
+
+// @public
+export interface FanState extends DeviceState {
+    speed: number;
+    state: "On" | "Off";
+}
+
+// @public
+export interface Keypad extends Keypad_2 {
+    // (undocumented)
+    readonly buttons: Button[];
+    set(status: KeypadState): Promise<void>;
+    readonly status: KeypadState;
+}
+
+// @public
+export interface KeypadState extends DeviceState {
+    led: Address_2;
+    state: "On" | "Off";
+}
+
+// @public
+export interface Occupancy extends Occupancy_2 {
+    readonly status: OccupancyState;
+    update(status: AreaStatus_2): void;
+}
+
+// @public
+export interface OccupancyState extends DeviceState {
+    state: "Occupied" | "Unoccupied";
+}
+
+// @public
+export function pair(): Promise<void>;
+
+// @public
+export interface Remote extends Remote_2 {
+    // (undocumented)
+    readonly buttons: Button[];
+}
+
+// @public
+export interface Shade extends Shade_2 {
+    set(status: ShadeState): Promise<void>;
+    readonly status: ShadeState;
+    update(status: ZoneStatus_2): void;
+}
+
+// @public
+export interface ShadeState extends DeviceState {
+    level: number;
+    state: "Open" | "Closed";
+    tilt?: number;
+}
+
+// @public
+export interface Strip extends Strip_2 {
+    set(status: StripState): Promise<void>;
+    readonly status: StripState;
+    update(status: ZoneStatus_2): void;
+}
+
+// @public
+export interface StripState extends DeviceState {
+    level: number;
+    luminance: number;
+    state: "On" | "Off";
+}
+
+// @public
+export interface Switch extends Switch_2 {
+    set(status: SwitchState): Promise<void>;
+    readonly status: SwitchState;
+    update(status: ZoneStatus_2): void;
+}
+
+// @public
+export interface SwitchState extends DeviceState {
+    state: "On" | "Off";
+}
+
+// @public
+export interface Timeclock extends Timeclock_2 {
+    readonly status: TimeclockState;
+    update(status: TimeclockStatus_2): void;
+}
+
+// @public
+export interface TimeclockState extends DeviceState {
+    state: "On" | "Off";
+}
+
+// @public
+export interface Unknown extends Unknown_2 {
+}
+
+```