Skip to content

Commit 58d67da

Browse files
Merge pull request #16 from ApolloAutomation/rename-service-calls-to-actions-and-fixed-logo
[github page] Renamed service calls to actions and fixed logo
2 parents 4e6ed92 + 662f9ff commit 58d67da

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# PUMP-1 Smart Pump Controller
22

3-
![Apollo Automation Logo](path/to/logo.png)
3+
![Apollo Automation Logo](https://apolloautomation.com/cdn/shop/files/PUMP-1_Main_2.jpg)
44

55
An ESPHome-based intelligent pump controller with advanced safety features, water level monitoring, and flexible control options. The PUMP-1 is designed for reliable water management in various applications including drainage, filling, and automated irrigation systems.
66

@@ -22,7 +22,7 @@ An ESPHome-based intelligent pump controller with advanced safety features, wate
2222
1. **Home Assistant Integration**: Full control via Home Assistant dashboard
2323
2. **Web Interface**: Built-in web server for local control
2424
3. **Physical Button**: Quick pump activation via reset button tap
25-
4. **API Services**: Programmatic control through ESPHome API
25+
4. **API Actions**: Programmatic control through ESPHome API
2626
5. **Manual Switch**: Direct pump control toggle
2727

2828
### Monitoring & Alerts
@@ -72,15 +72,15 @@ automation:
7272
- platform: time
7373
at: "06:00:00"
7474
action:
75-
- service: esphome.apollo_pump_1_run_pump_for_seconds
75+
- action: esphome.apollo_pump_1_run_pump_for_seconds
7676
data:
7777
seconds: 60
7878
```
7979
80-
### API Service Call
80+
### API Action Call
8181
```yaml
8282
# Run pump for specific duration
83-
service: esphome.apollo_pump_1_run_pump_for_seconds
83+
action: esphome.apollo_pump_1_run_pump_for_seconds
8484
data:
8585
seconds: 30
8686
```
@@ -91,7 +91,7 @@ data:
9191
9292
## 🔌 API Documentation
9393
94-
### Available Services
94+
### Available Actions
9595
9696
#### `run_pump_for_seconds`
9797
Runs the pump for a specified duration.
@@ -110,9 +110,7 @@ Plays a custom RTTTL melody.
110110
| `pump_control` | Switch | Main pump control |
111111
| `water_exists` | Binary Sensor | Water detection status |
112112
| `pump_run_seconds` | Number | Configurable runtime |
113-
| `water_protection_override` | Switch | Bypass water safety |
114-
| `hourly_water_check_enabled` | Switch | Enable hourly monitoring |
115-
| `invert_water_logic` | Switch | Reverse water logic |
113+
| `pump_safety_override` | Switch | Bypass max safe run time |
116114

117115
## 🛡️ Safety Features
118116

0 commit comments

Comments
 (0)