diff --git a/README.md b/README.md index 148504fbaaf84d7b9efae4a956a4d8f3fdf9ad5b..291fe8a0b667330ca86f2a902c80e8053e6eed20 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,84 @@ A biblioteca em Python do SACADA permite que sejam desenvolvidas aplicações ci # Instalação -TODO [PIP] +A biblioteca, junto com o comando `sacada` pode ser instalada globalmente com o comando +``` +sudo pip3 install -U sacada-python +``` + +Caso deseje instalar apenas localmente, ou se não tiver acesso ao sudo, instale utilizando +``` +pip3 install --user -U sacada-python +``` +Tome cuidado que, neste caso, o comando `sacada` ficará disponível apenas em `~/.local/bin`, que deverá estar no seu `PATH`. --- # Uso +##Biblioteca + TODO [Exemplos](/Exemplos) +## Comando + +O comando `sacada` permite a interface com a placa via terminal. Ele faz uso de uma interface serial, então é importante que você tenha as permissões corretas para acesso. Caso você esteja tendo erros de permissão, tente se colocar no grupo `dialout` utilizando o comando `sudo usermod -aG dialout [seu usuario]` e relogue no seu computador. + +Para testar a comunicação, você pode utilizar o comando `sacada show`, que deve retornar a string de identificação da placa que você está utilizando. Para especificar uma porta, você pode utilizar o parâmetro `--port [sua porta]`. Por padrão, a porta utilizada é a `/dev/ttyACM0`. É importante frisar que a SACADA possui **duas** portas seriais, e que a utilizada para comunicação é **sempre a de número menor**. + +**Exemplos:** +``` +[tropos@cta-001 ~]$ sacada show +blazing.design/UFRGS,SACADA Mini,0,rev1 +``` + +``` +[tropos@cta-001 ~]$ sacada --port /dev/ttyACM123 show +blazing.design/UFRGS,SACADA Mini,0,rev1 +``` + +**O parâmetro --port deve ser sempre o primeiro do comando** + +Para medir um canal único, você pode utilizar o comando `read`: + +**Exemplo:** +``` +[tropos@cta-001 ~]$ sacada read A0 +3.29312515258789 +``` + +Caso você deseje monitorar um canal continuamente, pode utilizar o comando `monitor`. Você também pode especificar um arquivo para salvar os dados utilizando o parâmetro `--save`. O intervalo de amostragem pode ser especificado (em milisegundos) com o parâmetro `--interval`. + +**Exemplos:** +``` +# Monitora o canal A0 com o intervalo padrão de 1000ms + +[tropos@cta-001 ~]$ sacada monitor A0 +3.29312515258789 +3.29187512397766 +3.29175019264221 +... +``` + +``` +# Monitora o canal A0 com intervalo de 100ms +[tropos@cta-001 ~]$ sacada monitor A0 --interval 100 +3.29287505149841 +3.28575015068054 +3.28275012969971 +... +``` + +``` +# Salva no arquivo ~/logs/out.log as amostras lidas +[tropos@cta-001 ~]$ sacada monitor A0 --save ~/logs/out.log +3.29275012016296 +3.29187512397766 +3.29212522506714 +``` + +** Os valores lidos e monitorados sempre serão dados em Volts** + --- # Licença