Pentair Screenlogic Configuration Software
Pentair Screenlogic 2 Setup

Chocolatey is software management automation for Windows that wraps installers, executables, zips, and scripts into compiled packages. Chocolatey integrates w/SCCM, Puppet, Chef, etc. Chocolatey is trusted by businesses to manage software deployments.

Latest version

Released:

Pentair's ScreenLogic Connect is a convenient interface for your pool and spa, designed specifically for the iPhone, iPod touch, iPad and now Apple.
Pentair's ScreenLogic Connect is a convenient interface for your pool and spa, designed specifically for the iPhone, iPod touch, iPad and now Apple.

Interface for Pentair ScreenLogic connected pool controllers over IP via Python

Project description

screenlogicpy is an interface for Pentair ScreenLogic connected pool controllers over IP via python.

The screenlogicpy package can be installed from PyPI using pip.

The ScreenLogicGateway class is the primary interface.

Gateway Discovery

The discovery module's discover() function can be used to get a list of all discovered ScreenLogic gateways on the local network. Each gateway is represented as a dict object that can then be directly used to instanciate a ScreenLogicGateway class.

Querying data

The ScreenLogicGateway class updates all data at once from the ScreenLogic gateway. That data is cached as a dict object for continued reference by the consuming application. The consuming application may get this data at anytime with the get_data() method.

Updating the data

When instanciated, the ScreenLogicGateway class object will perform an initial update of all available data to populate it's internal cache. A consuming application may request further updates of the internal data with the update() method.

After update(), The consuming application may then query the new data with get_data().

Note: This update consists of:

Connecting and logging-on to the specified ScreenLogic gateway.
Sending requests for
1. Pool controller configuration
2. Current pool status
3. Detailed information for each configured pump
4. Detailed pool chemistry information
Closing the connection to the gateway.

Warning: This method is not rate-limited. The calling application is responsible for maintaining reasonable intervals between updates.

Performing actions

The following actions can be performed with methods on the ScreenLogicGateway object:

Set a specific circuit to on or off
Set a heating mode for a specific body of water (spa/pool)
Set a target heating temperature for a specific body of water (spa/pool)
Select various color-enabled lighting options

Each method will return True if the operation reported no exceptions.Note: The methods do not confirm the requested action is now in effect on the pool controller.

Turning a circuit ON or OFF

A circuit can be requested to be turned on or off with the set_circuit() method. set_circuit takes two required arguments, circuitID which is the id number of the circuit as an int, and circuitState which represents the desired new state of the circuit, as an int. See Circuit State below.

Setting a heating mode

The desired heating mode can be set per body of water (pool or spa) with set_heat_mode(). set_heat_mode takes two required arguments, body as an int representing the body of water, and mode as an int of the desired heating mode.

Setting a target temperature

The target heating temperature can be set per body of water (pool or spa) with set_heat_temp(). set_heat_temp takes two required arguments, body as an int representing the body of water, and temp as an int of the desired target temperature.

Setting light colors or shows

Colors or color-shows can be set for compatible color-enable lighting with set_color_lights(). set_color_lights takes one required argument, light_command as an int representing the desired command/show/color

Screenlogicpy can also be used via the command line. The primary design is for the command line output to be consume/parsed by other applications and thus by default is not very human-readable. For more human-friendly output, specify the -v option.

Basic usage

Without any arguments, screenlogicpy will attempt to discover a gateway on the LAN, and display a human readable 'dashboard' of the current state of their pool.

Argument usage

Optional arguments

`-h, --help`

Argparse help command. Available at any stage of positional commands.

`-v, --verbose`

Tells screenlogicpy to be a little more verbose in it's output. Friendlier for humans.

`-i, --ip`

Specify the IP address of the ScreenLogic gateway to connect to. Note: If the IP address is not specified, screenlogicpy will attempt to discover ScreenLogic gateways on the local network, and connect to the first one that responds. This is generally fine if you only have one ScreenLogic gateway.

`-p, --port`

Specify the port of the ScreenLogic gateway to connect to. Needs to be used in conjunction with -i, --ip option.

Positional arguments

`discover`

Attempts to discover ScreenLogic gateways on the local network via UDP broadcast. Returns [ip address]:[port] of each discovered ScreenLogic gateway, one per line.

`get`

The get option is use with additional options to return the current state of the additional option specified.

get `circuit, c`

Returns 1 for on and 0 for off

get `heat-mode, hm`

Returns the current heating mode for the specified body of water.Note:[body] can be an int or string representing the body of water.

get `heat-temp, ht`

Returns the current target heating temperature for the specified body of water.Note:[body] can be an int or string representing the body of water.

get `heat-state, hs`

Returns the current state of the heater for the specified boty of water. The current state will match the heat mode when heating is active, otherwise will be 0 (off).Note:[body] can be an int or string representing the body of water.

get `current-temp, t`

Returns the current temperature for the specified body of water. This is actually the last-known temperature from when that body of water was active (Pool or Spa)Note:[body] can be an int or string representing the body of water.

get `json, j`

Returns a json dump of all data cached in the data dict.

`set`

All set commands work like their corresponding get commands, but take an additional argument or arguments for the desired setting.

set `circuit, c`

Sets the specified circuit to the specified circuit state. Note:[circuit state] can be an int or string representing the desired circuit state.

set `heat-mode, hm`

Sets the desired heating mode for the specified body of water.Note:[body] can be an int or string representing the body of water. [heat mode] can be an int or string representing the desired heat mode

set `heat-temp, ht`

Sets the desired target heating temperature for the specified body of water.Note:[body] can be an int

Project description

Gateway Discovery

Querying data

Updating the data

Performing actions

Turning a circuit ON or OFF

Setting a heating mode

Setting a target temperature

Setting light colors or shows

Basic usage

Argument usage

Optional arguments

-h, --help

-v, --verbose

-i, --ip

-p, --port

Positional arguments

discover

get

get circuit, c

get heat-mode, hm

get heat-temp, ht

get heat-state, hs

get current-temp, t

get json, j

set

set circuit, c

set heat-mode, hm

set heat-temp, ht

Pentair Screenlogic Software