daikin-local-control 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +22 -5
  2. package/package.json +14 -2
package/README.md CHANGED
@@ -1,10 +1,11 @@
1
1
  # daikin-local-control
2
2
 
3
- A TypeScript client for controlling Daikin air-conditioner Wi-Fi adapters **over
4
- the local network**, with no cloud dependency. It implements the same
5
- local-control protocol as the **DAIKIN Mobile Controller** app, so it works with
6
- the units and Wi-Fi adapters that app supports — split / multi-split and SkyAir
7
- units fitted with adapters such as the BRP072A42, BRP072C42 and BRP084 — in the
3
+ A TypeScript and Node.js client for controlling Daikin air conditioners **over
4
+ the local network** (LAN), through their Wi-Fi adapters and with no cloud
5
+ dependency. It implements the same local-control protocol as the **DAIKIN Mobile
6
+ Controller** app, so it works with the units and Wi-Fi adapters that app
7
+ supports — split / multi-split and SkyAir units fitted with adapters such as the
8
+ BRP072A42, BRP072C42 and BRP084 — in the
8
9
  [markets where that app is used](#coverage--limitations).
9
10
 
10
11
  Daikin Wi-Fi adapters come in two generations, and the package has a client for
@@ -19,6 +20,17 @@ each:
19
20
  You normally don't pick one yourself: `createDaikinClient` chooses the right
20
21
  client for each discovered device.
21
22
 
23
+ ## Installation
24
+
25
+ ```bash
26
+ npm install daikin-local-control
27
+ ```
28
+
29
+ It needs Node 22.19 or later, and its types are included.
30
+
31
+ Before `1.0.0`, only a minor release (`0.1.x` to `0.2.0`) can require changes
32
+ to your code, and the `^` range npm saves by default never crosses one.
33
+
22
34
  ## Usage
23
35
 
24
36
  ```ts
@@ -295,6 +307,11 @@ pnpm fix # check, applying safe fixes
295
307
 
296
308
  `pnpm install` sets up a [lefthook](https://lefthook.dev) pre-commit hook that runs `pnpm fix` on staged files.
297
309
 
310
+ To release, push a tag `vX.Y.Z`, or publish a GitHub release that creates it:
311
+ CI sets the version from the tag and publishes to npm.
312
+ [AGENTS.md](AGENTS.md#version-the-package-with-semver) says which number to
313
+ pick.
314
+
298
315
  ## Legal disclaimer
299
316
 
300
317
  An independent, community project for local interoperability and home automation.
package/package.json CHANGED
@@ -1,20 +1,30 @@
1
1
  {
2
2
  "name": "daikin-local-control",
3
- "version": "0.1.1",
4
- "description": "Unofficial local-network (LAN) control client for Daikin air-conditioner Wi-Fi adapters (classic CGI and DSIOT)",
3
+ "version": "0.1.2",
4
+ "description": "Unofficial Node.js and TypeScript client for controlling Daikin air conditioners over the local network (LAN), with no cloud. Supports classic (BRP069, BRP072) and DSIOT (BRP084) Wi-Fi adapters.",
5
5
  "keywords": [
6
6
  "daikin",
7
+ "daikin-ac",
8
+ "daikin-api",
7
9
  "daikin-mobile-controller",
8
10
  "air-conditioner",
11
+ "air-conditioning",
9
12
  "aircon",
13
+ "hvac",
10
14
  "local-control",
15
+ "local-api",
11
16
  "lan",
12
17
  "wifi-adapter",
18
+ "brp069",
13
19
  "brp072a42",
14
20
  "brp072c42",
15
21
  "brp084",
16
22
  "dsiot",
23
+ "skyair",
17
24
  "home-automation",
25
+ "smart-home",
26
+ "nodejs",
27
+ "typescript",
18
28
  "thailand",
19
29
  "singapore",
20
30
  "hong-kong",
@@ -24,6 +34,8 @@
24
34
  "new-zealand"
25
35
  ],
26
36
  "license": "GPL-3.0-or-later",
37
+ "homepage": "https://github.com/cheziyi/daikin-local-control#readme",
38
+ "bugs": "https://github.com/cheziyi/daikin-local-control/issues",
27
39
  "repository": {
28
40
  "type": "git",
29
41
  "url": "git+https://github.com/cheziyi/daikin-local-control.git"