No project description provided
Project description
Caninos SDK
Estamos criando uma SDK para fazer com que o uso da Labrador fique muito acessível. O objetivo é permitir códigos assim:
# as 4 linhas abaixo já funcionam:
import caninos_sdk as k9
labrador = k9.Labrador()
labrador.pin15.enable_gpio(k9.Pin.Direction.OUTPUT, alias="led_status")
labrador.camera.enable()
# as próximas 5 ainda não (precisa ser desenvolvido)
labrador.pin2.enable_gpio(k9.Pin.Direction.INPUT, alias="button1")
labrador.pin.enable_gpio(k9.cpu_pin(0x33), k9.INPUT, alias="button1")
labrador.pin.enable_gpio(7, k9.I2C, address=0x4, alias="temp_sensor")
labrador.pin.enable_gpio(9, k9.SPI, address=0x4, alias="temp_sensor")
labrador.wifi.enable("CITI", "1cbe991a14")
print(labrador.enabled_features())
# uso
labrador.led_status.high() # já funciona
res = labrador.button1.read() # ainda não
value = labrador.temp_sensor.read() # ainda não
ip = labrador.wifi.get_ip() # ainda não
ok, frame = labrador.camera.read() # já funciona
Caso queira ajudar com a implementação, dê uma olhadinha nos issues.
Começando
Piscando um LED - o Hello World do hardware
# importa a SDK e dá a ela um apelido bonitinho
import caninos_sdk as k9
# instancia o objeto labrador
labrador = k9.Labrador()
# habilita o pino 15 como saída, e dá a ele o apelido "led_status"
labrador.pin15.enable_gpio(k9.Pin.Direction.OUTPUT, alias="led_status")
# liga o "led_status"
labrador.led_status.high()
# desliga o "led_status"
labrador.led_status.low()
# liga o mesmo led de novo, porém agora se referindo a ele pelo número do pino
labrador.pin15.high()
⚠️ Atenção: para usar as GPIOs sem sudo
, é necessário rodar os comandos abaixo, toda vez que se reinicia a placa:
sudo chown caninos /dev/gpiochip*
sudo chmod g+rw /dev/gpiochip*
Outros exemplos
Confira a pasta examples do repositório no GitHub.
⚠️ Atenção: para usar a câmera, é necessário instalar o OpenCV. Instale-o com o comando abaixo:
sudo apt install python3-opencv
Contributing
First, see the issues page.
Then, install some dependencies:
sudo apt install python3-dev python3-pip python3-setuptools libffi-dev libssl-dev curl
pip3 install --upgrade pip
Finally, install the package locally in editable form:
pip3 install -e .
Publish a new version
Install build deps: pip3 install build twine
.
Update the version number at __init__.py
and setup.cfg
.
# build the new version
python3 -m build
# deploy
twine upload -r testpypi dist/*.whl # to https://test.pypi.org/
twine upload -r dist/*.whl # to https://pypi.org/
TO-DO:
- initial sketch to prove the concept
- make the gpios actually work (read/write)
- [ ] create default constructors/subclasses for specific boards- [ ] create a "VirtualLabrador" class, for tests and remote labs - refactor to a proper python package using modern python conventions
- [-] write unit tests -> works with
pytest -s
- gpio read/write work across Labradors 32/64
- support pwm
- support i2c
- support spi
- support wifi
- support camera
Other notes:
- should this library support other SBCs?
- should the docs be in English or Portuguese?
- need to get funding or community help
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for caninos_sdk-0.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1624e4aebe1d7d1cfa3142e8f8d7d1b43fbb6bbf36c3d415784f1d8eb317e3ef |
|
MD5 | 939623f6e37904b5b4431b1c48297c04 |
|
BLAKE2b-256 | d017a6a471c91a6a019c80cffb38c131ac32b3b607a0eef86f57d87c425e8d2b |