open-index/open-npm huggingface dataset:
npm package: @nzws/docker-modem
Description: Docker remote API network layer module.
Author: Pedro Dias
Latest version: 5.0.3

# docker-modem

[Docker](https://www.docker.com/)'s Remote API network layer module.

`docker-modem` will help you interacting with `Docker`, since it already implements all the network strategies needed to support all `Docker`'s Remote API endpoints.

It is the module powering (network wise) [dockerode](https://github.com/apocas/dockerode) and other modules.

## Usage

### Getting started

``` js
var Modem = require('docker-modem');
var modem1 = new Modem({socketPath: '/var/run/docker.sock'});
var modem2 = new Modem(); //defaults to above if env variables are not used
var modem3 = new Modem({host: 'http://192.168.1.10', port: 3000});
var modem4 = new Modem({protocol:'http', host: '127.0.0.1', port: 3000});
var modem5 = new Modem({host: '127.0.0.1', port: 3000}); //defaults to http
```

### SSH

You can connect to the Docker daemon via SSH in two ways:

* Using the built-in SSH agent.
* Implement your own custom agent.

``` js
//built-in SSH agent
var modem1 = new Modem({
  protocol: 'ssh',
  host: 'ssh://127.0.0.1',
  port: 22
});

//custom agent
var customAgent = myOwnSSHAgent({host: 'ssh://127.0.0.1', port: 22});
var modem2 = new Modem({
  agent: customAgent,
});
```

## Tests

 * Tests are implemented using `mocha` and `chai`. Run them with `npm test`.
 * Check [dockerode](https://github.com/apocas/dockerode) tests, which is indirectly co-testing `docker-modem`.

## Sponsors

Amazing entities that [sponsor](https://github.com/sponsors/apocas) my open-source work. Check them out!

[![HTTP Toolkit](https://avatars.githubusercontent.com/u/39777515?s=100)](https://github.com/httptoolkit)

## License

Pedro Dias - [@pedromdias](https://twitter.com/pedromdias)

Licensed under the Apache license, version 2.0 (the "license"); You may not use this file except in compliance with the license. You may obtain a copy of the license at:

http://www.apache.org/licenses/LICENSE-2.0.html

Unless required by applicable law or agreed to in writing, software distributed under the license is distributed on an "as is" basis, without warranties or conditions of any kind, either express or implied. See the license for the specific language governing permissions and limitations under the license.
npm package: @nzws/homebridge-converter
Description: Homebridge Plugin that convert accessories for integration with other home systems.
Latest version: 0.1.4

# @nzws/homebridge-converter

> Homebridge Plugin that convert accessories for integration with other home systems.  
> 他のホームシステムに連携するためにアクセサリを変換するプラグイン

## Features

- Lock accessory → Switch accessory
  - google home / alexa などでロックアクセサリは円滑な操作ができないため
- ...(todo)

## Install

```
npm install --global @nzws/homebridge-converter
```

- HomebridgeインスタンスはInsecureモードで起動する必要があります

## Config

```json
{
  "accessory": "HBConverter",
  "name": "Room Lock",
  "pin": "031-45-154",
  "port": 51239,
  "aid": 25,
  "type": "lock"
}
```

- `pin`: Homebridge Pin code
- `port`: Homebridge Instance Port
- `aid`: Accessory aid
- `type`: Accessory Type
  - `lock`: Lock → Switch
npm package: @nzws/homebridge-mqtt-fan
Description: Homebridge Plugin for homemade fan control created with mqtt
Latest version: 0.1.1

# @nzws/homebridge-mqtt-fan

## Install

```
npm install --global @nzws/homebridge-mqtt-fan
```

## Config

```json
{
  "accessory": "MQTTFan",
  "name": "Fan",
  "mqtt": {
    "host": "localhost",
    "port": 1883,
    "username": "",
    "password": ""
  },
  "degrees": {
    "off": 0,
    "on": [
      12,
      24
    ]
  }
}
```

- `mqtt`: MQTT Broker address.
- `degrees`: Set the angle for on/off
npm package: @nzws/homebridge-mqtt-smartlock
Description: Homebridge Plugin for homemade smart lock created with mqtt
Latest version: 0.3.0

# @nzws/homebridge-mqtt-smartlock

## Install

```
npm install --global @nzws/homebridge-mqtt-smartlock
```

## Config

```json
{
  "accessory": "MQTTLocker",
  "name": "Room Lock",
  "mqtt": {
    "host": "localhost",
    "port": 1883,
    "username": "",
    "password": ""
  },
  "degrees": {
    "locked": [170, 83],
    "unlocked": [0, 83]
  },
  "degreesInterval": 500
}
```

- `mqtt`: MQTT Broker address.
- `degrees`: Set the angle for unlocking/locking.
  - example `[170, 83]`: set angle to 170 → wait (degreesInterval)ms → set angle to 83
npm package: @nzws/homebridge-nature-aircon
Description: Aircon Control for Homebridge + Nature Remo
Latest version: 1.0.2

# @nzws/homebridge-nature-aircon

> エアコン操作プラグイン

Homebridge + Nature Remo でエアコンを操作するプラグインです。
サービスに [Heater Cooler](https://developers.homebridge.io/#/service/HeaterCooler) を使用しているため、風量などの機能が使用できます。

- 私の環境のエアコンでしかテストしていないため、機能が使用できない場合があります。

## Config

```json
{
  "accessory": "NatureAircon",
  "name": "Aircon",
  "accessToken": "/* https://home.nature.global/ */",
  "airconId": "/* uuid */"
}
```
npm package: @nzws/homebridge-sesame-os2
Description: Homebridge Plugin for SESAME OS2 (SESAME3)
Latest version: 1.1.1

# @nzws/homebridge-sesame-os2

> Homebridge Plugin for SESAME OS2 (SESAME3)

## Install

```bash
npm install -g @nzws/homebridge-sesame-os2
```

## Config

```json
{
  "accessory": "SESAMEOS2",
  "name": "Home Key",
  "uuid": "",
  "accessToken": "",
  "secretKey": ""
}
```

- config
  - `uuid`: アプリの鍵設定画面から取得
  - `accessToken`: https://dash.candyhouse.co/ から取得
  - `intervalSeconds`: 鍵の状態の更新秒数 (デフォルト: 300 秒)
    - レートリミットの関係で Too Many Requests が返される場合があります、操作できなくなった場合は大きめに設定してください
  - `displayName`: 履歴の表示名 (デフォルト: Homebridge)

### シークレットの指定方法

どちらかを入力してください。

- `secretKey`: https://sesame-qr-reader.vercel.app/ で QR コードを解析し、 `Secret Key` を入力
- `secret`: 鍵の共有 QR コードの `sk` パラメータから取得
  - QR コードを生成して読み取って `ssm://UI?t=sk&sk=[secret]&l=...` の部分

## Contact

- Mastodon: [@nzws@don.nzws.me](https://don.nzws.me/@nzws)