libmd1200/README.md
2025-08-23 15:09:14 +10:00

28 lines
765 B
Markdown

# libmd1200
Python library for the MD1200 disk shelf, `VERY WIP` but in rapid development
## Requirements (Software)
- pyserial
## Requirements (Hardware)
- MD1200
- Serial connection
## Usage
Simply construct a `MD1200` object with the path to the serial device like
```python
from libmd1200 import MD1200
SERIAL_DEVICE = "/dev/ttyUSB0"
md1200 = MD1200(SERIAL_DEVICE)
```
From there the following funcitons have been implemented
- MD1200.get_temps()
- Returns a Temperature object
- MD1200.set_speed(SPEED)
- Sends the `_shutup` command with the fan speed in percentage
- MD1200.get_commands(INCLUDE_SUPERS)
- Gets all the available commands from the MD1200 disk shelf, INCLUDE_SUPERS is a bool that includes administrative and debug commands