mqtt2matter 0.3.2 → 0.4.0

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.
@@ -1,14 +1,25 @@
1
1
  /* The MQTT connection: mqtt.js with reconnect, the subscriptions it re-establishes itself, a message
2
- event with the raw payload, and the topic cache fed with everything that arrives. */
2
+ event with the raw payload, and the topic cache fed with everything that arrives. A connection error never
3
+ ends the process: mqtt.js keeps reconnecting, and the errors are logged with a backoff so a broker that is
4
+ away for hours does not fill the log. */
3
5
  import { EventEmitter } from 'node:events';
4
6
  import mqtt, {} from 'mqtt';
5
7
  import { TopicCache } from "./topic-cache.js";
8
+ /** the first connection error is logged at once, the next ones after 10 s, 20 s, 40 s … at most every 10 min */
9
+ export const ERROR_LOG_FIRST_DELAY_MS = 10_000;
10
+ export const ERROR_LOG_MAX_DELAY_MS = 600_000;
6
11
  export class MqttClient extends EventEmitter {
7
12
  cache = new TopicCache();
8
13
  options;
9
14
  log;
10
15
  client;
11
16
  subscriptions = new Set();
17
+ /** connection errors since the last one logged */
18
+ suppressedErrors = 0;
19
+ nextErrorLog = 0;
20
+ errorLogDelay = ERROR_LOG_FIRST_DELAY_MS;
21
+ wasConnected = false;
22
+ abortConnect;
12
23
  constructor(options, log) {
13
24
  super();
14
25
  this.options = options;
@@ -17,7 +28,10 @@ export class MqttClient extends EventEmitter {
17
28
  get connected() {
18
29
  return this.client?.connected ?? false;
19
30
  }
20
- /** connect and resolve on the first CONNACK; rejects after `connectTimeout` or on a refused connection */
31
+ /**
32
+ * Connect and resolve on the first CONNACK. Without `connectTimeout` it waits as long as the broker is away
33
+ * (mqtt.js retries every `reconnectPeriod`); with one it rejects after that time, naming the last error.
34
+ */
21
35
  async connect() {
22
36
  if (this.client !== undefined) {
23
37
  return;
@@ -35,36 +49,77 @@ export class MqttClient extends EventEmitter {
35
49
  }
36
50
  const client = mqtt.connect(this.options.url, clientOptions);
37
51
  this.client = client;
52
+ let lastError;
38
53
  client.on('connect', () => {
39
- this.log.info(`connected to ${this.options.url}`);
54
+ const errors = this.suppressedErrors;
55
+ this.resetErrorLog();
56
+ this.wasConnected = true;
57
+ this.log.info(`connected to ${this.options.url}${errors > 0 ? ` (${errors} more connection error(s) not logged)` : ''}`);
40
58
  this.emit('connect');
41
59
  });
42
60
  client.on('close', () => {
43
- this.log.warn(`connection to ${this.options.url} closed`);
61
+ // mqtt.js closes after every failed attempt too; only losing a connection is worth a line
62
+ if (this.wasConnected) {
63
+ this.wasConnected = false;
64
+ this.log.warn(`connection to ${this.options.url} closed, reconnecting`);
65
+ }
44
66
  this.emit('close');
45
67
  });
46
68
  client.on('error', (error) => {
47
- this.log.error('mqtt error', error);
48
- this.emit('error', error);
69
+ lastError = error;
70
+ this.logError(error);
49
71
  });
50
72
  client.on('message', (topic, payload, packet) => {
51
73
  this.cache.store(topic, payload, packet.retain);
52
74
  this.emit('message', topic, payload, packet.retain);
53
75
  });
54
76
  await new Promise((resolve, reject) => {
55
- const timeout = setTimeout(() => {
56
- reject(new Error(`no connection to ${this.options.url} within ${this.options.connectTimeout ?? 30_000} ms`));
57
- }, this.options.connectTimeout ?? 30_000);
77
+ const timeoutMs = this.options.connectTimeout;
78
+ const timeout = timeoutMs === undefined
79
+ ? undefined
80
+ : setTimeout(() => {
81
+ this.abortConnect = undefined;
82
+ reject(new Error(`no connection to ${this.options.url} within ${timeoutMs} ms` +
83
+ (lastError === undefined ? '' : `: ${lastError.message}`)));
84
+ }, timeoutMs);
85
+ this.abortConnect = (error) => {
86
+ clearTimeout(timeout);
87
+ reject(error);
88
+ };
89
+ const waiting = setTimeout(() => {
90
+ if (!client.connected) {
91
+ this.log.warn(`waiting for the broker at ${this.options.url}`);
92
+ }
93
+ }, 2000);
94
+ waiting.unref();
58
95
  client.once('connect', () => {
59
96
  clearTimeout(timeout);
97
+ clearTimeout(waiting);
98
+ this.abortConnect = undefined;
60
99
  resolve();
61
100
  });
62
- client.once('error', (error) => {
63
- clearTimeout(timeout);
64
- reject(error);
65
- });
66
101
  });
67
102
  }
103
+ /** log a connection error now, or count it until the backoff has passed */
104
+ logError(error) {
105
+ const now = Date.now();
106
+ if (now < this.nextErrorLog) {
107
+ this.suppressedErrors += 1;
108
+ return;
109
+ }
110
+ const more = this.suppressedErrors;
111
+ this.suppressedErrors = 0;
112
+ this.nextErrorLog = now + this.errorLogDelay;
113
+ this.log.error(`mqtt error: ${error.message}` +
114
+ (more > 0 ? ` (and ${more} more since the last one logged)` : '') +
115
+ `; retrying, the next error is logged in ${Math.round(this.errorLogDelay / 1000)} s at the earliest`);
116
+ this.errorLogDelay = Math.min(this.errorLogDelay * 2, ERROR_LOG_MAX_DELAY_MS);
117
+ }
118
+ resetErrorLog() {
119
+ this.suppressedErrors = 0;
120
+ this.nextErrorLog = 0;
121
+ this.errorLogDelay = ERROR_LOG_FIRST_DELAY_MS;
122
+ }
68
123
  /** subscribe once; mqtt.js re-subscribes after a reconnect (clean session, so we keep the list ourselves too) */
69
124
  async subscribe(topic) {
70
125
  if (this.subscriptions.has(topic)) {
@@ -86,6 +141,8 @@ export class MqttClient extends EventEmitter {
86
141
  async close() {
87
142
  const client = this.client;
88
143
  this.client = undefined;
144
+ this.abortConnect?.(new Error('closed before the broker was reached'));
145
+ this.abortConnect = undefined;
89
146
  if (client !== undefined) {
90
147
  await client.endAsync();
91
148
  }
@@ -1 +1 @@
1
- {"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/mqtt/client.ts"],"names":[],"mappings":"AAAA;uFACuF;AAEvF,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAEzC,OAAO,IAAI,EAAE,EAAsD,MAAM,MAAM,CAAC;AAGhF,OAAO,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAyB5C,MAAM,OAAO,UAAW,SAAQ,YAAwB;IAC3C,KAAK,GAAG,IAAI,UAAU,EAAE,CAAC;IACjB,OAAO,CAAc;IACrB,GAAG,CAAS;IACrB,MAAM,CAA2B;IACxB,aAAa,GAAG,IAAI,GAAG,EAAU,CAAC;IAEnD,YAAY,OAAoB,EAAE,GAAW;QACzC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACnB,CAAC;IAED,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,MAAM,EAAE,SAAS,IAAI,KAAK,CAAC;IAC3C,CAAC;IAED,0GAA0G;IAC1G,KAAK,CAAC,OAAO;QACT,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO;QACX,CAAC;QACD,MAAM,aAAa,GAAmB;YAClC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,eAAe,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE;YAC3F,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe,IAAI,IAAI;YACrD,KAAK,EAAE,IAAI;SACd,CAAC;QACF,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACtC,aAAa,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QACnD,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACtC,aAAa,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QACnD,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC7D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;YACtB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;YAClD,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACpB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,IAAI,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC,CAAC;YAC1D,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YACzB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;YACpC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;YAC5C,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;YAChD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QACH,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxC,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC5B,MAAM,CACF,IAAI,KAAK,CACL,oBAAoB,IAAI,CAAC,OAAO,CAAC,GAAG,WAAW,IAAI,CAAC,OAAO,CAAC,cAAc,IAAI,MAAM,KAAK,CAC5F,CACJ,CAAC;YACN,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,IAAI,MAAM,CAAC,CAAC;YAC1C,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE;gBACxB,YAAY,CAAC,OAAO,CAAC,CAAC;gBACtB,OAAO,EAAE,CAAC;YACd,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;gBAC3B,YAAY,CAAC,OAAO,CAAC,CAAC;gBACtB,MAAM,CAAC,KAAK,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAED,iHAAiH;IACjH,KAAK,CAAC,SAAS,CAAC,KAAa;QACzB,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,OAAO;QACX,CAAC;QACD,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC9B,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO;QACX,CAAC;QACD,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QACxC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,KAAK,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,KAAa,EAAE,OAAwB,EAAE,UAA0B,EAAE;QAC/E,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;QACrC,CAAC;QACD,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,EAAC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,EAAC,CAAC,CAAC;IAC7G,CAAC;IAED,KAAK,CAAC,KAAK;QACP,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC5B,CAAC;IACL,CAAC;CACJ"}
1
+ {"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/mqtt/client.ts"],"names":[],"mappings":"AAAA;;;2CAG2C;AAE3C,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAEzC,OAAO,IAAI,EAAE,EAAsD,MAAM,MAAM,CAAC;AAGhF,OAAO,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAa5C,gHAAgH;AAChH,MAAM,CAAC,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAC/C,MAAM,CAAC,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAa9C,MAAM,OAAO,UAAW,SAAQ,YAAwB;IAC3C,KAAK,GAAG,IAAI,UAAU,EAAE,CAAC;IACjB,OAAO,CAAc;IACrB,GAAG,CAAS;IACrB,MAAM,CAA2B;IACxB,aAAa,GAAG,IAAI,GAAG,EAAU,CAAC;IACnD,kDAAkD;IAC1C,gBAAgB,GAAG,CAAC,CAAC;IACrB,YAAY,GAAG,CAAC,CAAC;IACjB,aAAa,GAAG,wBAAwB,CAAC;IACzC,YAAY,GAAG,KAAK,CAAC;IACrB,YAAY,CAAuC;IAE3D,YAAY,OAAoB,EAAE,GAAW;QACzC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACnB,CAAC;IAED,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,MAAM,EAAE,SAAS,IAAI,KAAK,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO;QACT,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO;QACX,CAAC;QACD,MAAM,aAAa,GAAmB;YAClC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,eAAe,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE;YAC3F,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe,IAAI,IAAI;YACrD,KAAK,EAAE,IAAI;SACd,CAAC;QACF,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACtC,aAAa,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QACnD,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACtC,aAAa,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QACnD,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC7D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,SAA4B,CAAC;QACjC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;YACtB,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,CAAC;YACrC,IAAI,CAAC,aAAa,EAAE,CAAC;YACrB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;YACzB,IAAI,CAAC,GAAG,CAAC,IAAI,CACT,gBAAgB,IAAI,CAAC,OAAO,CAAC,GAAG,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,uCAAuC,CAAC,CAAC,CAAC,EAAE,EAAE,CAC5G,CAAC;YACF,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACpB,0FAA0F;YAC1F,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACpB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;gBAC1B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,IAAI,CAAC,OAAO,CAAC,GAAG,uBAAuB,CAAC,CAAC;YAC5E,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YACzB,SAAS,GAAG,KAAK,CAAC;YAClB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;YAC5C,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;YAChD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QACH,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;YAC9C,MAAM,OAAO,GACT,SAAS,KAAK,SAAS;gBACnB,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE;oBACZ,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;oBAC9B,MAAM,CACF,IAAI,KAAK,CACL,oBAAoB,IAAI,CAAC,OAAO,CAAC,GAAG,WAAW,SAAS,KAAK;wBACzD,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,OAAO,EAAE,CAAC,CAChE,CACJ,CAAC;gBACN,CAAC,EAAE,SAAS,CAAC,CAAC;YACxB,IAAI,CAAC,YAAY,GAAG,CAAC,KAAK,EAAE,EAAE;gBAC1B,YAAY,CAAC,OAAO,CAAC,CAAC;gBACtB,MAAM,CAAC,KAAK,CAAC,CAAC;YAClB,CAAC,CAAC;YACF,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC5B,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;oBACpB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,6BAA6B,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;gBACnE,CAAC;YACL,CAAC,EAAE,IAAI,CAAC,CAAC;YACT,OAAO,CAAC,KAAK,EAAE,CAAC;YAChB,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE;gBACxB,YAAY,CAAC,OAAO,CAAC,CAAC;gBACtB,YAAY,CAAC,OAAO,CAAC,CAAC;gBACtB,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;gBAC9B,OAAO,EAAE,CAAC;YACd,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC;IAED,2EAA2E;IACnE,QAAQ,CAAC,KAAY;QACzB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,IAAI,GAAG,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;YAC1B,IAAI,CAAC,gBAAgB,IAAI,CAAC,CAAC;YAC3B,OAAO;QACX,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACnC,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC;QAC7C,IAAI,CAAC,GAAG,CAAC,KAAK,CACV,eAAe,KAAK,CAAC,OAAO,EAAE;YAC1B,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,kCAAkC,CAAC,CAAC,CAAC,EAAE,CAAC;YACjE,2CAA2C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,oBAAoB,CAC3G,CAAC;QACF,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,GAAG,CAAC,EAAE,sBAAsB,CAAC,CAAC;IAClF,CAAC;IAEO,aAAa;QACjB,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACtB,IAAI,CAAC,aAAa,GAAG,wBAAwB,CAAC;IAClD,CAAC;IAED,iHAAiH;IACjH,KAAK,CAAC,SAAS,CAAC,KAAa;QACzB,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,OAAO;QACX,CAAC;QACD,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC9B,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO;QACX,CAAC;QACD,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QACxC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,KAAK,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,KAAa,EAAE,OAAwB,EAAE,UAA0B,EAAE;QAC/E,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;QACrC,CAAC;QACD,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,EAAC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,EAAC,CAAC,CAAC;IAC7G,CAAC;IAED,KAAK,CAAC,KAAK;QACP,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,YAAY,EAAE,CAAC,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC,CAAC;QACvE,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;QAC9B,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC5B,CAAC;IACL,CAAC;CACJ"}
package/docs/config.md CHANGED
@@ -259,7 +259,7 @@ Without `format`, `payload` and `template` the payload is the value as text (an
259
259
 
260
260
  ### Templates
261
261
 
262
- Jinja through `@huggingface/jinja`, Home Assistant style. Available: expressions, `if … else …`, loops, the
262
+ Jinja through `@huggingface/jinja`, Home Assistant style (the engine of mqtt-ha-entities). Available: expressions, `if … else …`, dictionaries with any keys (`{0: 'off', 1: 'on'}[value]`), loops, the
263
263
  filters `int` (Home Assistant's `int(default, base)`: `'ff' | int(0, 16)`), `float`, `string`, `bool`, `lower`, `upper`, `trim`, `abs`, `default`, `length`, `join`,
264
264
  `replace`, `tojson`, `round(precision, method, default)`, `is_defined`, `iif`, `multiply`, `is_number`, `max`,
265
265
  `min`; the tests `defined`, `none`, `number`, `string`; the functions `iif`, `float`, `int`, `max`, `min`.
package/docs/importers.md CHANGED
@@ -207,8 +207,8 @@ merged over every entity (each repeats it, often only with its identifiers).
207
207
 
208
208
  **Templates** go to the payload engine when it can run them: the importer parses every `*_template` with the
209
209
  same library and checks the filters, tests, functions and free names against what the engine provides
210
- ([config.md](config.md), "Templates"; `src/importers/ha/templates.ts`). A template it cannot run — `states()`,
211
- `now()`, `this`, the time and regex helpers, `int(base=16)`, a dictionary with integer keys, macros — leaves
210
+ ([config.md](config.md), "Templates"; the check is mqtt-ha-entities'). A template it cannot run — `states()`,
211
+ `now()`, `this`, the time and regex helpers, macros — leaves
212
212
  that half of the mapping out and is listed under `unmapped` with the template text, so the user sees what to
213
213
  write by hand. Where Home Assistant's command template sees a value the engine names differently, a `{% set …
214
214
  %}` prelude gives it Home Assistant's meaning: `value` is `ON` / `OFF` (`payload_on` / `payload_off`) for a
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mqtt2matter",
3
- "version": "0.3.2",
3
+ "version": "0.4.0",
4
4
  "description": "Generic MQTT to Matter bridge: compose Matter devices by hand and map them onto MQTT topics with configurable payloads; importers for Zigbee2MQTT and Home Assistant MQTT discovery",
5
5
  "type": "module",
6
6
  "license": "Apache-2.0",
@@ -63,9 +63,9 @@
63
63
  "deploy": "bash deploy.sh"
64
64
  },
65
65
  "dependencies": {
66
- "@huggingface/jinja": "0.5.10",
67
66
  "@matter/main": "0.18.0",
68
67
  "mqtt": "^5.16.1",
68
+ "mqtt-ha-entities": "^0.1.0",
69
69
  "ws": "^8.22.0",
70
70
  "zod": "^4.6.7"
71
71
  },