Use BoPi with Home Assistant and others

If you want to add BoPi, BoPi Max or BoPi Basic to control your pool from your Home Assistant setup, you can find a step by step guide as well as all the configuration files, scripts and dashboard cards on GitHub here : https://github.com/debrouillestoi/BoPi-HomeAssistant/

BoPi has a Rest API that can be enabled in the settings (requires BoPi to have a wifi connection). Once wifi si set and API enabled, you can get BoPi’s IP ADDRESS from the dasboard in the Apps and use that IP to connect to BoPi on your local network and execute requests.

All data sent or received is in JSON format. If needed, you can test those requests with an app like Postman on your computer.

/allsensors

Version 1.x

This endpoint returns all current values for BoPi’s sensors as well as pool pump relay and light relay status and information.

Request URL : http://bopi-ip-address:80/allsensors

Request Type : GET

Response :

[
{ “type”: “airtemp”, “value”: 19.2 },
{ “type”: “watertemp”, “value”: 19.4 },
{ “type”: “boxtemp”, “value”: 21.7 },
{ “type”: “boxhumidity”, “value”: 69 },
{ “type”: “phvalue”, “value”: 7.4 },
{ “type”: “redoxvalue”, “value”: 740 },
{
“type”: “poolPump”,
“status”: false, // false = off, true = on
“override”: 0,
“timeleft”: 0 // If override, time left in seconds
},
{
“type”: “poolLights”,
“status”: false, // false = off, true = on
“timeleft”: 0 // If on, time left in seconds
}
]

/poolpump

Version 1.x

This endpoint allows you to override the pool pump status. This will ignore the planned operations until the time has elapsed.

Request URL : http://bopi-ip-address:80/poolpump

Request Type : POST

Request :

{
“overrideto”: 0,  // 1 = on, 0 = off
“deadline”: 600 // Duration in hours
}

Response : 200 OK

/poollights

Version 1.x

This endpoint allows you to override the pool lights status.

Request URL : http://bopi-ip-address:80/poollights

Request Type : POST

Request :

{
“newstatus”: 0,  // 1 = on, 0 = off
“deadline”: 600 // Duration in hours
}

Response : 200 OK

/allsensorsv2

Version 2.x

This endpoint reports all current information including sensors, operation and statuses from BoPi.

Request URL : http://bopi-ip-address:80/allsensorsv2

Request Type : GET

Response :

/getrelay

Version 2.x

This endpoint gets information about a specific relay’s current status. Can be used to check after setting a relay.

Request URL : http://bopi-ip-address:80/getrelay

Request Type : GET

Response :

/setrelay

Version 2.x

This endpoint allows you to set a relay’s status.

Request URL : http://bopi-ip-address:80/setrelay

Request Type : POST

Request :

Response :

/getmode

Version 2.x

This endpoint reports the current operating mode of BoPi.

Request URL : http://bopi-ip-address:80/getmode

Request Type : GET

Response :

/setmode

Version 2.x

This endpoint allows you to set an operating mode for BoPi.

Request URL : http://bopi-ip-address:80/setmode

Request Type : POST

Request :

Response :