Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bostrt/homebridge-bali-blinds
Bali Motorized Blinds Plugin for Homebridge
https://github.com/bostrt/homebridge-bali-blinds
blinds ezlo homebridge homebridge-bali-blinds homebridge-plugin mios
Last synced: about 15 hours ago
JSON representation
Bali Motorized Blinds Plugin for Homebridge
- Host: GitHub
- URL: https://github.com/bostrt/homebridge-bali-blinds
- Owner: bostrt
- License: apache-2.0
- Created: 2023-03-22T19:49:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-05T18:02:51.000Z (9 months ago)
- Last Synced: 2024-04-24T12:07:53.916Z (5 months ago)
- Topics: blinds, ezlo, homebridge, homebridge-bali-blinds, homebridge-plugin, mios
- Language: TypeScript
- Homepage:
- Size: 671 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Homebridge Plugin for Bali Blinds
This is a [Homebridge](https://homebridge.io/) plugin for [Bali Blinds](https://www.baliblinds.com/motorization/). The Bali Motorization mobile application used to control the blinds only supports Amazon Alex and Google Assistant (as of 2023) hence this plugin's existence.
(Thanks [@hjdhjd](https://github.com/hjdhjd/homebridge-blinds-cmd), I copied some of your Install and Configuration section :smile:)
# Installation
If you have installed the [Homebridge Config UI](https://github.com/oznu/homebridge-config-ui-x), you can intall this plugin by going to the Plugins tab and searching for `homebridge-bali-blinds` and installing it.
Or, if you prefer to install `homebridge-bali-blinds` from the command line, you can do so by executing:
```
sudo npm install -g homebridge-bali-blinds
```
# Configuration
I strongly recommend using the [Homebridge Config UI](https://github.com/oznu/homebridge-config-ui-x) rather than editing your config.json directly. It does a good job of showing you all the options and always generating a valid configuration so you don't get stuck on typos or looking for stray commas in your config.json.
For those that prefer configuring things directly, add the accessory in `config.json` in your home directory inside `.homebridge`.
```json
"platforms": [
{
"gateways": [
{
"baliUsername": "your-username",
"baliPassword": "your-password",
"baliGatewayId": "12345678", // Optional
"lowBattery": 33 // Optional
}
],
"platform": "BaliBlinds"
}
]
```
## Options
- `baliUsername`: *(Required)* Username from Bali Motorization mobile app. It is recommended creating a new user in mobile app with "Basic User" permission levels since no Admin or Advanced permissions are required by this plugin.
- `baliPassword`: *(Required)* Password for the user above.
- `baliGatewayId`: *(Optional)* The Bali Gateway ID. This can be found in your Bali Motorization mobile app. If you do not specify a Gateway ID, then the first one associated with your account is automatically used.
- `lowBattery`: *(Optional)* Default 33%. The percentage threshold at which the low battery status will be set on Homebridge blinds accessories.
## Multiple Gateways
If you have multiple Bali Gateways/Hubs, you can add each one to your configuration. You can do this in the Homebridge Config UI but clicking the "Add to Gateways" button.
Alternatively, you can add a new sectino to the `gateways` array like this:
```json
"platforms": [
{
"gateways": [
{
"baliUsername": "your-username",
"baliPassword": "your-password",
"baliGatewayId": "12345678", // Optional
"lowBattery": 33 // Optional
},
{
"baliUsername": "your-username",
"baliPassword": "your-password",
"baliGatewayId": "98765432", // Optional
"lowBattery": 33 // Optional
}
],
"platform": "BaliBlinds"
}
]
```
## Where do I find my Gateway ID?
In the Bali Motorization mobile app, you can find it on the home login screen where you select the gateway to connect to:
# Fun Facts and Random Bits
I'm not an expert with IoT products, MiOS, Ezlo, Vera, or really any of the technologies used in this plugin. If you see something that doesn't make sense or could be improved please let me know by opening a GitHub issue to discuss.
## Plugin Design
The design of this plugin is that it communicates with an HTTP API hosted by MiOS and Ezlo. This HTTP API is connected (polled I think) to the Bali Gateway device (Ezlo Atom) that communicates ZWave with the blinds. At first, I considered this solution pretty round-about when I could just speak ZWave directly to the blinds *from* Homebridge but I believe there is some benefit to not requiring more hardware. If you already have a ZWave device connected to Homebridge there are probably other plugins you can use to benefit from the direct communication.
```mermaid
flowchart LR;
A[Homebridge Plugin] --> B[MiOS/Ezlo HTTP API];
B <--> C[Bali Gateway*];
C --> D[ZWave];
D --> E[Blinds];
F[Mobile App] --> B;
G[Physical Remote**] --> C;
```
```
* Bali Gateway is an Ezlo Atom hub usb device
** The physical remote is Somfy brand device
```
## Documentation and References
During development of this plugin I used various references including but not limited to:
- Legacy MiOS documentation since it appears Bali Motorization is built on legacy cloud infra: https://developer.mios.com/api/legacy-cloud-api/documents/
- This gist from @cgmartin https://gist.github.com/cgmartin/466bd2d3724de6c04743d61cf0de2066 which I adapted to Bali https://gist.github.com/bostrt/f8189ce83e6fa6fb573aea2f1e76b723
- The Bali Motorization Android APK for `PK_Oem` and `AppKey` parameters.
- Ezlo Hub Kit source code which this plugin is very roughly based on: https://github.com/bblacey/ezlo-hub-kit/
# Development
See [DEVELOPMENT.md](DEVELOPMENT.md)
## Plugin Development Dashboard
[](https://github.com/bostrt/homebridge-bali-blinds/blob/main/LICENSE)
[](https://github.com/bostrt/homebridge-bali-blinds/actions)
[](https://www.npmjs.com/package/homebridge-bali-blinds)
