From 4791b2a4b67f27735bdc9632daa450af32fcb787 Mon Sep 17 00:00:00 2001 From: Dominik Roth Date: Thu, 10 Oct 2024 16:45:06 +0200 Subject: [PATCH] Updated README --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c642b6e..ebcbc63 100644 --- a/README.md +++ b/README.md @@ -76,10 +76,12 @@ Class methods: - `nucon.set_dummy_mode(dummy_mode)`: Enable or disable dummy mode for testing Custom Enum Types: -- `PumpStatus`: Enum for pump status (INACTIVE, ACTIVE_NO_SPEED_REACHED, ACTIVE_SPEED_REACHED, REQUIRES_MAINTENANCE, NOT_INSTALLED, INSUFFICIENT_ENERGY) -- `PumpDryStatus`: Enum for pump dry status (ACTIVE_WITHOUT_FLUID, INACTIVE_OR_ACTIVE_WITH_FLUID) -- `PumpOverloadStatus`: Enum for pump overload status (ACTIVE_AND_OVERLOAD, INACTIVE_OR_ACTIVE_NO_OVERLOAD) -- `BreakerStatus`: Enum for breaker status (OPEN, CLOSED) +- `PumpStatus`: Enum for pump status (INACTIVE, ACTIVE_NO_SPEED_REACHED\*, ACTIVE_SPEED_REACHED\*, REQUIRES_MAINTENANCE, NOT_INSTALLED, INSUFFICIENT_ENERGY) +- `PumpDryStatus`: Enum for pump dry status (ACTIVE_WITHOUT_FLUID\*, INACTIVE_OR_ACTIVE_WITH_FLUID) +- `PumpOverloadStatus`: Enum for pump overload status (ACTIVE_AND_OVERLOAD\*, INACTIVE_OR_ACTIVE_NO_OVERLOAD) +- `BreakerStatus`: Enum for breaker status (OPEN\*, CLOSED) + +\*: Truthy value (will be treated as true in e.g. if statements). So if you're not in the mood to play the game manually, this API can be used to easily create your own automations and control systems. Maybe a little PID controller for the rods? Or, if you wanna go crazy, why not try some