Metadata-Version: 2.4
Name: hydrakit
Version: 1.0.0
Summary: Biblioteca Python para controlar placas HydraKit via USB serial.
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: pyserial>=3.5

# HydraKit — biblioteca Python

Biblioteca Python para controlar o firmware HydraKit por USB serial em Arduino Uno R3 / ATmega328P.

## 1. Requisitos

- Python 3.9 ou superior
- Arduino Uno R3 / Nano ATmega328P com o firmware compatível gravado
- Firmware respondendo `OK,MAKERKIT,1.0.0` ao comando `HELLO`
- Cabo USB com transmissão de dados

## 2. Instalar em modo de desenvolvimento

Abra o terminal do VS Code na pasta extraída, onde está `pyproject.toml`, e execute:

```powershell
python -m pip install -e .
```

Se o comando `python` não funcionar, use o caminho completo do Python instalado, por exemplo:

```powershell
& "$env:LOCALAPPDATA\Programs\Python\Python311\python.exe" -m pip install -e .
```

A biblioteca instala `pyserial` como dependência.

## 3. Exemplo: piscar D13

Execute:

```powershell
python examples/blink_d13.py
```

O programa detecta a porta serial, valida a placa com `HELLO` e pisca D13. Pressione Ctrl+C para interromper.

## 4. Exemplo mínimo

```python
from hydrakit import HydraKit

with HydraKit() as board:
    print(board.port)
    board.pin_mode(13, "OUTPUT")
    board.digital_write(13, 1)
    board.digital_write(13, 0)
```

## 5. Comandos disponíveis

- `board.connect()` — conectar à placa
- `board.close()` — fechar conexão
- `board.ping()` — testar comunicação
- `board.capabilities()` — ler capacidades do firmware
- `board.pin_mode(pin, "OUTPUT" | "INPUT" | "PULLUP")`
- `board.digital_write(pin, 0 ou 1)`
- `board.digital_read(pin)`
- `board.analog_read(0)` ou `board.analog_read("A0")`
- `board.pwm(pin, duty)` — PWM em D3, D5, D6, D9, D10, D11
- `board.tone(pin, frequency)`
- `board.no_tone(pin)`
- `board.read_all()` — leituras digitais e analógicas em dicionário

## 6. Notas importantes

- O firmware atual usa o identificador `OK,MAKERKIT,1.0.0` apesar de o projeto se chamar HydraKit. A biblioteca espera exatamente essa resposta.
- D0 e D1 ficam reservados para comunicação serial.
- No firmware atual, DWRITE exige que o pino tenha sido configurado antes com `pin_mode(pin, "OUTPUT")`.
- `READALL` lê os pinos mesmo que não estejam configurados como entrada; confira o modo elétrico antes de conectar circuitos.
- A abertura da porta pode reiniciar o Uno. A biblioteca espera 2 segundos antes de testar `HELLO`.
- Se aparecer erro de acesso à porta, feche o Monitor Serial da Arduino IDE e outros programas que possam estar usando a COM.
- Não conecte 12 V diretamente aos pinos do Arduino. Use drivers adequados para relés, motores e outras cargas.
