@bitpoolos/edge-bacnet 1.2.8 → 1.3.1

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 (17) hide show
  1. package/CHANGELOG.md +105 -0
  2. package/README.md +23 -2
  3. package/bacnet_client.js +843 -803
  4. package/bacnet_device.js +132 -60
  5. package/bacnet_gateway.html +92 -76
  6. package/bacnet_gateway.js +161 -46
  7. package/bacnet_read.html +1048 -598
  8. package/bacnet_read.js +68 -84
  9. package/bacnet_server.js +270 -205
  10. package/bacnet_write.html +329 -24
  11. package/common.js +23 -5
  12. package/package.json +2 -2
  13. package/resources/bitArray.js +167 -0
  14. package/resources/node-bacstack-ts/dist/lib/asn1.js +16 -5
  15. package/resources/node-bacstack-ts/dist/lib/client.js +6 -7
  16. package/resources/style.css +321 -0
  17. package/treeBuilder.js +545 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,105 @@
1
+ # Changelog
2
+
3
+ ## [1.3.1] - 06-06-2024
4
+
5
+ ### Summary
6
+
7
+ Primarily bug fixes and performance improvements
8
+
9
+ ### Bug Fixes
10
+
11
+ - Adding individual points for MSTP devices would add incorrect device name to read list
12
+
13
+ - Adding individual points for IP devices would add all MSTP network folders to read list
14
+
15
+ - Intermittent incorrect device naming issues
16
+
17
+ - Fixed BACnet server incompatibility with YABE and other BACnet browsers.
18
+
19
+ - Added undefined check to bacstack client
20
+
21
+ ### Improvements
22
+
23
+ - First poll cycle only queries Object Name and Present Value properties for all applicable Object Types for smaller initial network load. Objects are then back populated with the remaining Object properties on the subsequent poll cycles.
24
+
25
+ - Devices are immediately added to the UI tree with a device placeholder on a whoIs/iAm response. The devices are then back populated with Names and BACnet Objects. This gives the user a fast understanding of the size and relationships of the BACnet network.
26
+
27
+ - Added docstrings to bacnet_server.js and code clean up.
28
+
29
+ - Set Server enable to default on True
30
+
31
+
32
+ ## [1.3.0] - 16-05-2024
33
+
34
+ ### Summary
35
+
36
+ This release includes several new features, bug fixes, and performance improvements.
37
+
38
+ ### New Features
39
+
40
+ - Moved device "Online" & "Offline" status from coloured text to a green or red circle preceeding the device name
41
+
42
+ - Implemented MSTP device count icon
43
+
44
+ - Introduced separate MSTP NET{networkNumber} folders for child MSTP devices for logical separation
45
+
46
+ - Updated Add All button to add all sub MSTP devices if parent IP device button is selected
47
+
48
+ - Introduced Right click context menu for all device types present in Device List:
49
+ - Purge Device
50
+ - Purges device from active model, removing it from the device list
51
+ - Update Points
52
+ - Triggers point updating function for selected device, beneficial for large bacnet networks
53
+ - Add All Points
54
+ - Same as Add All button
55
+ - Remove All Points
56
+ - Same as Remove All button
57
+ - Set device name
58
+ - Sets device Display Name, which is used in the output of read operations
59
+
60
+ - Introduced Right click context menu for all points present in the Device List:
61
+ - Set point Name
62
+ - Sets point display name, used in the output of read operations
63
+ - Update point
64
+ - Triggers point update function, forces latest present value
65
+
66
+ - Introduced Export and Import of ReadList in the read node.
67
+ - This feature Exports a light weight JSON file with all devices and points added to the Read List. This allows the user to rename all of the devices and points in the Read List via a plain text editor, then Import the modified file. The process of importing will update the Display Names of desired points and device. This feature was introduced with the intention of streamlinibg the naming convetions and processes used for site deployment.
68
+
69
+ - Added support for debian systems, displays All Interfaces (0.0.0.0) in network adapter property
70
+
71
+ - Added publish status under gateway node
72
+
73
+ - Implemented usage of gateway and read node names in MQTT topics
74
+ - {gateway node name}/{read node name}/pointName
75
+
76
+
77
+
78
+ ### Bug Fixes
79
+
80
+ - UI Bug Fixes
81
+
82
+ - Write to MSTP devices bug fix
83
+
84
+
85
+ ### Performance Improvements
86
+
87
+ - Added support for a wider range of devices.
88
+
89
+ - Added getProtocolsSupported request to identify bacnet service support for each device
90
+
91
+ - Added apduSize based readPropertyMultiple packaging for reduced network requests
92
+
93
+ - Refactored device tree function and implemented treeBuilder.
94
+
95
+ - Refactored device object building / querying process
96
+
97
+ - Refactored user injected read function
98
+
99
+ ### Other Changes
100
+
101
+ - Added Changelog
102
+
103
+ - Updated Readme for better node updating.
104
+
105
+ - Limited support to a set list of bacnet object types. The intention with this change is to improve performance by disregarding non-essential point types.
package/README.md CHANGED
@@ -34,6 +34,26 @@ or using NPM from the command line.
34
34
  $ npm install @bitpoolos/edge-bacnet
35
35
  ```
36
36
 
37
+ ## Updating
38
+
39
+ The module can be updated via the Node-RED pallette manager, or via the npm cli.
40
+
41
+ ```javascript
42
+ Upon updating to the latest version, we highly recommend:
43
+ - Check out the changelog for latest feature notes and updates
44
+ - Remove all @bitpoolos/edge-bacnet nodes from all flows
45
+ - Deploy all flows
46
+ - Restart Node-RED
47
+ - Insert and reconfigure new @bitpoolos/edge-bacnet nodes.
48
+ - Restart Node-RED again if no devices are discovered.
49
+ ```
50
+ Main reason being, the behaviour of the bacnet client binding to network interfaces can remain stagnent if the Node-RED service is not restarted. This also ensures that all of the nodes are correctly configured as there are often properties added and removed from nodes.
51
+
52
+
53
+ ## Changelog
54
+
55
+ [Changelog](CHANGELOG.md)
56
+
37
57
  ## Notes
38
58
 
39
59
  - This project is still in development and by no means perfect.
@@ -42,15 +62,16 @@ $ npm install @bitpoolos/edge-bacnet
42
62
 
43
63
  - If you are using this node in a linux environment, using the 'All interfaces : 0.0.0.0' can be more reliable with a greater range of BACnet devices.
44
64
 
65
+ - Note your broadcast address, compatibility can vary from 255.255.255.255 (all subnets) and 192.x.x.255 (locked down to your current subnet).
66
+
45
67
  ## Resources
46
68
  - [bitpool.com](https://www.bitpool.com/) - who are we.
47
- - [app.bitpool.com](https://app.bitpool.com/) - our platform.
48
69
  - [wiki.bitpool.com](https://wiki.bitpool.com/) - helpful docs.
49
70
  - [hub.docker.com](https://hub.docker.com/r/bitpoolos/bitpool-edge) - pre-canned nodes.
50
71
 
51
72
  ## Contributions
52
73
 
53
- This node utilises v0.2.4 of the node-bacnet package (https://github.com/BiancoRoyal/node-bacstack). None of the functionality here would be possible without the fantastic work done by the contributors of that project.
74
+ This node utilises v1.0.0-beta.2 of the node-bacnet package (https://github.com/HILA-TECH/ts-node-bacstack). None of the functionality here would be possible without the fantastic work done by the contributors of that project, and the original node-bacstack implementation (https://github.com/fh1ch/node-bacstack).
54
75
 
55
76
  ## License
56
77