Upload README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,22 @@
|
|
| 1 |
-
---
|
| 2 |
-
|
| 3 |
-
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# viet-robot-maintenance-reminder
|
| 2 |
+
|
| 3 |
+
A tiny rule-based helper that decides whether to remind the user about
|
| 4 |
+
basic maintenance tasks like emptying the dust bin or cleaning the brush.
|
| 5 |
+
|
| 6 |
+
Function:
|
| 7 |
+
|
| 8 |
+
```python
|
| 9 |
+
decide_maintenance_reminder(task_type: MaintTaskType, days_since_last: int) -> MaintReminder
|
| 10 |
+
```
|
| 11 |
+
|
| 12 |
+
where `task_type` is one of:
|
| 13 |
+
|
| 14 |
+
- `empty_bin`
|
| 15 |
+
- `clean_brush`
|
| 16 |
+
- `clean_filter`
|
| 17 |
+
- `firmware_update`
|
| 18 |
+
- `sensor_check`
|
| 19 |
+
|
| 20 |
+
## License
|
| 21 |
+
|
| 22 |
+
MIT
|