@companion-module/base 1.11.0 → 1.11.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.
- package/CHANGELOG.md +14 -0
- package/README.md +2 -1
- package/dist/helpers/udp.d.ts +2 -1
- package/dist/helpers/udp.d.ts.map +1 -1
- package/dist/helpers/udp.js +6 -4
- package/dist/helpers/udp.js.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [1.11.2](https://github.com/bitfocus/companion-module-base/compare/v1.11.1...v1.11.2) (2024-11-18)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Bug Fixes
|
|
7
|
+
|
|
8
|
+
* add rinfo to UDPHelper message event ([#103](https://github.com/bitfocus/companion-module-base/issues/103)) ([d7162c3](https://github.com/bitfocus/companion-module-base/commit/d7162c327183fb8ea9ad2e03facf700319b11b5b))
|
|
9
|
+
|
|
10
|
+
## [1.11.1](https://github.com/bitfocus/companion-module-base/compare/v1.11.0...v1.11.1) (2024-11-07)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Bug Fixes
|
|
14
|
+
|
|
15
|
+
* Resolving broadcast option within UDP Helper ([#101](https://github.com/bitfocus/companion-module-base/issues/101)) ([3ea9614](https://github.com/bitfocus/companion-module-base/commit/3ea9614788c135f053f8bb43ff74b7466694039e))
|
|
16
|
+
|
|
3
17
|
## [1.11.0](https://github.com/bitfocus/companion-module-base/compare/v1.10.0...v1.11.0) (2024-09-23)
|
|
4
18
|
|
|
5
19
|
|
package/README.md
CHANGED
|
@@ -21,7 +21,8 @@ Each version of Companion supports a limited range of versions of this library l
|
|
|
21
21
|
|
|
22
22
|
To get started with creating a new module, you should start with one of the following templates. These should be kept up to date, but you should make sure all the dependencies are up to date before you begin.
|
|
23
23
|
|
|
24
|
-
- https://github.com/bitfocus/companion-module-template
|
|
24
|
+
- https://github.com/bitfocus/companion-module-template-js (JavaScript)
|
|
25
|
+
- https://github.com/bitfocus/companion-module-template-ts (TypeScript)
|
|
25
26
|
|
|
26
27
|
## Documentation
|
|
27
28
|
|
package/dist/helpers/udp.d.ts
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
|
+
import dgram from 'dgram';
|
|
1
2
|
import { EventEmitter } from 'eventemitter3';
|
|
2
3
|
import { InstanceStatus } from '../module-api/enums.js';
|
|
3
4
|
type UDPStatuses = InstanceStatus.Ok | InstanceStatus.UnknownError;
|
|
4
5
|
export interface UDPHelperEvents {
|
|
5
6
|
error: [err: Error];
|
|
6
7
|
listening: [];
|
|
7
|
-
data: [msg: Buffer];
|
|
8
|
+
data: [msg: Buffer, rinfo: dgram.RemoteInfo];
|
|
8
9
|
status_change: [status: UDPStatuses, message: string | undefined];
|
|
9
10
|
}
|
|
10
11
|
export interface UDPHelperOptions {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"udp.d.ts","sourceRoot":"","sources":["../../src/helpers/udp.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"udp.d.ts","sourceRoot":"","sources":["../../src/helpers/udp.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAEvD,KAAK,WAAW,GAAG,cAAc,CAAC,EAAE,GAAG,cAAc,CAAC,YAAY,CAAA;AAElE,MAAM,WAAW,eAAe;IAE/B,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;IAEnB,SAAS,EAAE,EAAE,CAAA;IAEb,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAA;IAG5C,aAAa,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC,CAAA;CACjE;AAED,MAAM,WAAW,gBAAgB;IAChC,iBAAiB;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,uBAAuB;IACvB,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB,oBAAoB;IACpB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,iBAAiB;IACjB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,gBAAgB;IAChB,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB,wBAAwB;IACxB,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,qBAAa,SAAU,SAAQ,YAAY,CAAC,eAAe,CAAC;;IAU3D,IAAI,WAAW,IAAI,OAAO,CAEzB;gBAEW,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB;IAkE5D,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBnD,OAAO,IAAI,IAAI;CAoBf"}
|
package/dist/helpers/udp.js
CHANGED
|
@@ -46,9 +46,6 @@ class UDPHelper extends eventemitter3_1.EventEmitter {
|
|
|
46
46
|
catch (_e) {
|
|
47
47
|
throw new Error(`Unable to bind to ip/port: ${this.#options.bind_ip || '0.0.0.0'}:${this.#options.bind_port || 0}`);
|
|
48
48
|
}
|
|
49
|
-
if (this.#options.broadcast) {
|
|
50
|
-
this.#socket.setBroadcast(true);
|
|
51
|
-
}
|
|
52
49
|
if (this.#options.ttl !== undefined) {
|
|
53
50
|
this.#socket.setTTL(this.#options.ttl);
|
|
54
51
|
}
|
|
@@ -66,13 +63,18 @@ class UDPHelper extends eventemitter3_1.EventEmitter {
|
|
|
66
63
|
// this.socket.addMembership(member.shift())
|
|
67
64
|
// }
|
|
68
65
|
// }
|
|
66
|
+
// Needed to be called after bind() had completed
|
|
67
|
+
if (this.#options.broadcast) {
|
|
68
|
+
this.#socket.setBroadcast(true);
|
|
69
|
+
}
|
|
69
70
|
if (this.#options.multicast_interface) {
|
|
70
71
|
this.#socket.setMulticastInterface(this.#options.multicast_interface);
|
|
71
72
|
}
|
|
72
73
|
this.#new_status(enums_js_1.InstanceStatus.Ok);
|
|
73
74
|
this.emit('listening');
|
|
74
75
|
});
|
|
75
|
-
|
|
76
|
+
// Passing on rinfo to emit instead of omitting it
|
|
77
|
+
this.#socket.on('message', (data, rinfo) => this.emit('data', data, rinfo));
|
|
76
78
|
this.#missingErrorHandlerTimer = setTimeout(() => {
|
|
77
79
|
if (!this.#destroyed && !this.listenerCount('error')) {
|
|
78
80
|
// The socket is active and has no listeners. Log an error for the module devs!
|
package/dist/helpers/udp.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"udp.js","sourceRoot":"","sources":["../../src/helpers/udp.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAEH,0DAAyB;AACzB,iDAA4C;AAC5C,qDAAuD;AAiCvD,MAAa,SAAU,SAAQ,4BAA6B;IAClD,KAAK,CAAQ;IACb,KAAK,CAAQ;IACb,OAAO,CAAc;IACrB,QAAQ,CAAkB;IAEnC,UAAU,GAAG,KAAK,CAAA;IAClB,WAAW,CAA4B;IACvC,yBAAyB,CAA4B;IAErD,IAAI,WAAW;QACd,OAAO,IAAI,CAAC,UAAU,CAAA;IACvB,CAAC;IAED,YAAY,IAAY,EAAE,IAAY,EAAE,OAA0B;QACjE,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,IAAI,CAAC,QAAQ,GAAG,EAAE,GAAG,OAAO,EAAE,CAAA;QAE9B,qBAAqB;QACrB,gCAAgC;QAEhC,IAAI,CAAC,OAAO,GAAG,eAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QAEzC,IAAI,CAAC;YACJ,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;QACvE,CAAC;QAAC,OAAO,EAAE,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CACd,8BAA8B,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,EAAE,CAClG,CAAA;QACF,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,
|
|
1
|
+
{"version":3,"file":"udp.js","sourceRoot":"","sources":["../../src/helpers/udp.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;AAEH,0DAAyB;AACzB,iDAA4C;AAC5C,qDAAuD;AAiCvD,MAAa,SAAU,SAAQ,4BAA6B;IAClD,KAAK,CAAQ;IACb,KAAK,CAAQ;IACb,OAAO,CAAc;IACrB,QAAQ,CAAkB;IAEnC,UAAU,GAAG,KAAK,CAAA;IAClB,WAAW,CAA4B;IACvC,yBAAyB,CAA4B;IAErD,IAAI,WAAW;QACd,OAAO,IAAI,CAAC,UAAU,CAAA;IACvB,CAAC;IAED,YAAY,IAAY,EAAE,IAAY,EAAE,OAA0B;QACjE,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,IAAI,CAAC,QAAQ,GAAG,EAAE,GAAG,OAAO,EAAE,CAAA;QAE9B,qBAAqB;QACrB,gCAAgC;QAEhC,IAAI,CAAC,OAAO,GAAG,eAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QAEzC,IAAI,CAAC;YACJ,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;QACvE,CAAC;QAAC,OAAO,EAAE,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CACd,8BAA8B,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,EAAE,CAClG,CAAA;QACF,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YACrC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;QACvC,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;YAC/C,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAA;QAC1D,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAClC,IAAI,CAAC,WAAW,CAAC,yBAAc,CAAC,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;YAC5D,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAC1B,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE;YACjC,oBAAoB;YAEpB,yCAAyC;YACzC,iDAAiD;YACjD,8CAA8C;YAC9C,KAAK;YACL,IAAI;YAEJ,iDAAiD;YACjD,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC;gBAC7B,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;YAChC,CAAC;YAED,IAAI,IAAI,CAAC,QAAQ,CAAC,mBAAmB,EAAE,CAAC;gBACvC,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAA;YACtE,CAAC;YAED,IAAI,CAAC,WAAW,CAAC,yBAAc,CAAC,EAAE,CAAC,CAAA;YACnC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACvB,CAAC,CAAC,CAAA;QAEF,kDAAkD;QAClD,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAA;QAE3E,IAAI,CAAC,yBAAyB,GAAG,UAAU,CAAC,GAAG,EAAE;YAChD,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;gBACtD,+EAA+E;gBAC/E,OAAO,CAAC,KAAK,CAAC,0BAA0B,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,+BAA+B,CAAC,CAAA;YACjG,CAAC;QACF,CAAC,EAAE,IAAI,CAAC,CAAA;IACT,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,OAAwB;QAClC,IAAI,IAAI,CAAC,UAAU;YAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAA;QACxE,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAA;QAEtE,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC5C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE;gBAC5D,IAAI,KAAK,EAAE,CAAC;oBACX,MAAM,CAAC,KAAK,CAAC,CAAA;oBACb,OAAM;gBACP,CAAC;gBAED,OAAO,EAAE,CAAA;YACV,CAAC,CAAC,CAAA;QACH,CAAC,CAAC,CAAA;IACH,CAAC;IACD,0BAA0B;IAC1B,sBAAsB;IACtB,0CAA0C;IAC1C,YAAY;IACZ,sCAAsC;IACtC,KAAK;IACL,IAAI;IACJ,OAAO;QACN,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;QAEtB,IAAI,IAAI,CAAC,yBAAyB,KAAK,SAAS,EAAE,CAAC;YAClD,YAAY,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAA;YAC5C,IAAI,CAAC,yBAAyB,GAAG,SAAS,CAAA;QAC3C,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAA;QACjC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAA;QACpB,IAAI,CAAC,kBAAkB,EAAE,CAAA;IAC1B,CAAC;IAED,mBAAmB;IACnB,WAAW,CAAC,MAAmB,EAAE,OAAgB;QAChD,IAAI,IAAI,CAAC,WAAW,IAAI,MAAM,EAAE,CAAC;YAChC,IAAI,CAAC,WAAW,GAAG,MAAM,CAAA;YACzB,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QAC5C,CAAC;IACF,CAAC;CACD;AA1HD,8BA0HC"}
|