cryptk / cryptk/python-omnilogic-local

feat(cli): Add control commands (set temperature, on/off, speed)

Đang mở
#145 1 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
Python
Star
10
Fork
13
Merge trung bình
5 phút
Pull request đã merge (30 ngày)
2

Mô tả

## Summary

The CLI currently only exposes read-only commands (`get` and `debug` subgroups). The library itself fully supports equipment control via methods like `heater.set_temperature()`, `pump.set_speed()`, `light.turn_on()`, etc., but there is no way to invoke these operations from the command line.

## Motivation

Users who want to script pool control (e.g., cron jobs, home automation integrations, or wrapping the CLI in an HTTP API) currently have to write Python code using the library directly. Adding a `set` command group to the CLI would make equipment control accessible without any custom code.

### Use cases
- **Scripting**: `omnilogic --host 192.168.1.100 set heater-temp 1 4 82` to set pool heater to 82°F from a shell script
- **HTTP wrappers**: Lightweight API services that shell out to the CLI for control commands
- **Debugging/testing**: Quickly toggle equipment during development without writing async Python

## Proposed CLI interface

```
# Heater temperature control
omnilogic set heater-temp
omnilogic set solar-temp

# Equipment on/off
omnilogic set equipment-on
omnilogic set equipment-off

# Pump/filter speed
omnilogic set speed

# Light control
omnilogic set light-show [--brightness N] [--speed N]
```

## Implementation notes

- The high-level library already has all the primitives: `heater.set_temperature()`, `pump.set_speed()`, `light.turn_on()`, `light.set_show()`, etc.
- The CLI already instantiates `OmniLogic` and calls `refresh()` in the entrypoint, so adding a `set` command group would follow the same pattern as the existing `get` group.
- Equipment lookup by `bow_id`/`system_id` can use `omni.backyard.bow` and iterate equipment collections.

## Context

I ran into this gap while building a containerized HTTP API wrapper for my OmniLogic system. I ended up importing `pyomnilogic_local` directly to get temperature control since the CLI had no way to set heater temperatures. Happy to contribute a PR if this aligns with the project direction.

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Hướng nghiên cứu

Bắt đầu tại entrypoint của CLI, nơi OmniLogic được khởi tạo và refresh() được gọi, rồi so sánh nhóm set được đề xuất với nhóm get hiện có. Theo dõi các primitive của thư viện được liệt kê và việc tra cứu thiết bị thông qua omni.backyard.bow. Hoàn tất khi các lệnh heater, solar, equipment, speed và light được đề xuất gọi các control tương ứng với các đối số được ghi trong tài liệu.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
cli
Loại issue
Tính năng
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
45/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.