Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/henry-spanka/nubli
Nubli is a Node.JS library for Nuki Smart Locks
https://github.com/henry-spanka/nubli
bluetooth library node nuki smart-lock smarthome smartlock
Last synced: 14 days ago
JSON representation
Nubli is a Node.JS library for Nuki Smart Locks
- Host: GitHub
- URL: https://github.com/henry-spanka/nubli
- Owner: henry-spanka
- License: mit
- Created: 2019-02-05T20:12:10.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-01T09:59:45.000Z (about 4 years ago)
- Last Synced: 2024-10-26T09:09:26.150Z (21 days ago)
- Topics: bluetooth, library, node, nuki, smart-lock, smarthome, smartlock
- Language: TypeScript
- Size: 106 KB
- Stars: 15
- Watchers: 2
- Forks: 11
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Nubli
Nubli is a Node.JS library for Nuki Smart Locks (**Nu**ki **B**luetooth **Li**brary)
Nubli is very energy efficient when used properly and should't drain more power than a Nuki bridge. It uses the same protocol the App and Bridge uses and therefore communicates securely with the Smart Lock.
[](https://npmjs.org/package/nubli)
# Features
* Get Lock State of Nuki Smart Lock (including door sensor)
* Unlock/Lock/Unlatch/LockNGo Door
* Listen for Lock State and Door Sensor changes
* Get Authorizations
* Get Configuration
* Get Advanced Configuration
# Supported devices
- Nuki Smart Lock v2
- Nuki Smart Lock v1 (not yet 100% compatible - Please open an issue if something doesn't work)
# Requirements
- Linux-based Server (e.g. Raspberry Pi)
- Bluetooth 4.x Dongle (Tested with $5 CSR Module)
**Note**: Do not use the built-in Bluetooth in a Raspberry Pi. Due to bad hardware design it will not reliably connect to your Smart Lock and cause unexpected disconnects. I've been there and invested a whole week into fixing it.
# Setup / Installation
1. `npm install nubli --save`
2. See [Examples](examples/) or [Usage](#usage)
3. Star the repository ;)
# Notes
* You can only run one instance of this library simultaneously with one dongle. If want to integrate this library into multiple applications running at the same time on the same device, either pin the applications to different bluetooth dongles or communicate with a single instance of this library via a webserver/websocket/mqtt instead.
# Usage
```typescript
const nubli = require('nubli').default;
nubli.onReadyToScan()
.then(() => {
nubli.startScanning();
})
.catch((err) => {
console.log(err);
});
```
## Actions
### Start Scanning for Nuki devices
```typescript
nubli.startScanning(): void;
```
### Start Actively Scanning for Nuki devices (Required for pairing)
```typescript
nubli.startActiveScanning(): void;
```
**Notes**:
* Scanning requires the bluetooth device to be powered on. This may take a few milliseconds. Make sure to wait for the promise ```nubli.readyToScan()``` to resolve first.
* Only use active scanning when you are trying to pair a new device. Active Scanning will drain your Smart Lock's battery very quickly. Passive Scanning only listens for advertisements from the Smart Lock and does not request additionaly information from the Smart Lock.
### Stop Scanning for Nuki devices
```typescript
nubli.stopScanning(): void;
```
### Connect to a Smart Lock
```typescript
smartlock.connect(): Promise;
```
### Disconnect from a Smart Lock
```typescript
smartlock.disconnect(): Promise;
```
### Check if a config for the Smart Lock already exists
```typescript
smartlock.configExists(path?: string): boolean;
```
### Read Smart Lock config
```typescript
smartlock.readConfig(path?: string): Promise;
```
### Save Smart Lock config
```typescript
smartlock.saveConfig(path?: string): Promise;
```
### Pair with a Smart Lock
```typescript
smartlock.pair(asBridge = true): Promise;
```
**Note**: By default it will pair as bridge. If you do have a bridge, make sure to pass false as a parameter. The reason is, that when no bridge exists, Nuki will not push any state changes automatically via advertisements, so we set ourselves as a bridge instead.
### Read lock state from Smart Lock
```typescript
smartlock.readLockState(): Promise;
```
### Unlock door
```typescript
smartlock.unlock(updateCallback?: (response: SmartLockResponse) => void): Promise;
```
### Lock door
```typescript
smartlock.lock(updateCallback?: (response: SmartLockResponse) => void): Promise;
```
### Unlatch Door
```typescript
smartlock.unlatch(updateCallback?: (response: SmartLockResponse) => void): Promise;
```
### Lock N Go Door
```typescript
smartlock.lockNGo(updateCallback?: (response: SmartLockResponse) => void): Promise;
```
### Lock N Go Unlatch Door
```typescript
smartlock.lockNGoUnlatch(updateCallback?: (response: SmartLockResponse) => void): Promise;
```
### Get Config from Smart Lock
```typescript
smartlock.requestConfig(): Promise;
```
### Get Advanced Config from Smart Lock
```typescript
smartlock.requestAdvancedConfig(): Promise;
```
## Properties
### Check whether a Smart Lock is already paired
```typescript
smartlock.paired: boolean;
```
## Events
### Nubli Smart Lock Discovered Event
```typescript
nubli.on('smartLockDiscovered', (smartlock: SmartLock) => void);
```
### Nubli started scanning
```typescript
nubli.on('startedScanning', () => void);
```
### Nubli stopped scanning
```typescript
nubli.on('stoppedScanning', () => void);
```
### Smart Lock Connected Event
```typescript
smartlock.on('connected', () => void);
```
### Smart Lock Disconnected Event
```typescript
smartlock.on('disconnected', () => void);
```
### Smart Lock Error Event
```typescript
smartlock.on('error', (err: string) => void);
```
### Smart Lock Activity Log Changed Event
```typescript
smartlock.on('activityLogChanged', () => void);
```
**Note**: The `activityLogChanged` event only works while scanning because the Smart Lock advertises activity log changes via bluetooth. To get notified when the door opens or closes (Door Sensor) make sure to enable 'Log door sensor status' in the Nuki app.
# Help
If you have any questions or help please open an issue on the GitHub project page.
# Contributing
Pull requests are always welcome. If you have an issue or feature request please open a GitHub issue.
# License
The project is subject to the MIT license unless otherwise noted. A copy can be found in the root directory of the project [LICENSE](LICENSE).