close - Indicates that close() has been called on the finder.

searchAsync() will close the socket itself. This async call will also emit the serverFound message. Returns a LocalUnit array with each object containing: Optionally accepts a number of milliseconds to wait for units defaults to 5000 if not specified. There is a 5s timeout built in to this command, and no retry mechanism. This is a stateless UDP query, but the connection will automatically be closed, so you may need to issue another search if the first one doesn't work, if your network connection is not established, etc. Issues one UDP broadcast search for available units.

gatewayName - the gateway/unit name as a string.

This call does not return any found units directly, but does emit the serverFound message which contains each LocalUnit object that is found: There is no automatic timeout built in to this command. Since this is a stateless UDP query, the connection will not automatically be closed, so you may need to issue another search if the first one doesn't work, if your network connection is not established, etc.

Import * as Screenlogic from 'node-screenlogic' /*or const ScreenLogic = require('node-screenlogic') */ var finder = new ScreenLogic. Pull requests to document undocumented properties are most welcome.

The final 4 bytes are a little-endian-encoded length of the data payload on the packet. The second 2 bytes are a little-endian-encoded message ID. The first 2 bytes are a little-endian-encoded sender ID (which is normally specified when making the original request). Packet formatĪll ScreenLogic packets are sent with an 8-byte header. There are lots of available messages supported by ScreenLogic that the app doesn't support yet, but can be added pretty easily as needed. See screenlogic API reference.Īll communication with a ScreenLogic unit is done via TCP, so responses will come back in the order they were requested. Once you've connected with connectAsync(), there are a number of methods available and corresponding events for when they've completed successfully. Where password is the remote login password. init ( systemName, ipAddr, port, password ) // ipAddr and password as strings port as integer await client.

See example.ts for an example of interfacing with the library. See the Wiki for information on migrating from v1 to v2. Tested with a Pentair ScreenLogic system on firmware versions 5.2 Build 736.0 Rel, 5.2 Build 738.0 Rel Local connections require a Pentair ScreenLogic device on the same network (a network which supports UDP broadcasts). This is a Node.JS module for interfacing with Pentair ScreenLogic systems over your local network or remotely through the Pentair dispatcher.

Pentair screenlogic remote connection