https://github.com/bostrt/bali-gateway-kit

SDK for Bali Motorized Blinds
https://github.com/bostrt/bali-gateway-kit

Last synced: 3 months ago
JSON representation

SDK for Bali Motorized Blinds

• Host: GitHub
• URL: https://github.com/bostrt/bali-gateway-kit
• Owner: bostrt
• License: mit
• Created: 2023-12-07T16:30:26.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-02T20:27:24.000Z (7 months ago)
• Last Synced: 2024-10-10T13:20:03.343Z (3 months ago)
• Language: TypeScript
• Homepage:
• Size: 771 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: ReadMe.md
  • Contributing: Contributing.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Ezlo-Hub-Kit

![Continuous Integration](https://github.com/bostrt/bali-gateway-kit/workflows/Continuous%20Integration/badge.svg)![Publish NPM Package](https://github.com/bostrt/bali-gateway-kit/workflows/Publish%20NPM%20Package/badge.svg)

## Overview

Bali-Gateway-Kit is a [Node.js Package Manager](https://www.npmjs.com) module that provides a convenient, fully-typed, SDK for Bali's Motorization Gateways. The kit enables applications to discovery connected hubs given a Bali account, connect to them, retrieve properties such as devices and rooms, observe hub events and perform hub actions.

This project is very heavily based on this project https://github.com/bblacey/ezlo-hub-kit/. This project includes customizations so it can fully function with Bali's API.

## Installation

```zsh

npm install bali-gateway-kit --save

```

`ezlo-hub-kit` is a hybrid npm module that supports both commonJS and ESM modules with complete Typescript type definitions.

*ESM*

```ts

import { BaliCloudResolver, BaliGateway } from 'bali-gateway-kit';

```

*commonJS*

```js

const { BaliCloudResolver, BaliGateway } = require('bali-gateway-kit');

```

## Usage

*TODO*