... | ... | @@ -72,9 +72,7 @@ Essa é uma excelente maneira de aprender eletrônica, mesmo para aqueles não f |
|
|
|
|
|
## Utilizando o software
|
|
|
|
|
|
Tendo a placa montada com os sensores (seja via prototipagem ou com shield pronto), abra um terminal (linha de comando) e siga os seguintes passos para instalar o software que vai rodar no processador do Arduino, responsável por recolher a medida dos sensores.
|
|
|
|
|
|
> OBS: Assumimos aqui o uso de um sistema operacional Linux baseado em Debian.
|
|
|
> OBS: Assumimos aqui o uso de um sistema operacional Linux baseado em Debian (ex: Mint, Ubuntu, Debian, etc). Ao digitar os comandos, não inclua o `$` do início da linha.
|
|
|
|
|
|
### 1. Obtenha o código
|
|
|
|
... | ... | @@ -90,45 +88,42 @@ $ cd arduino-meteorolog |
|
|
```
|
|
|
Daqui em diante será assumido que você está dentro desta pasta ao executar os comandos `make`.
|
|
|
|
|
|
### 2. Configure o arquivo `settings.yaml`
|
|
|
### 2. Instale o firmware
|
|
|
|
|
|
Dentro da pasta [meteorolog](https://git.cta.if.ufrgs.br/meteorolog/arduino-meteorolog/tree/master/meteorolog) está o código C++ do programa (firmware) que rodará na placa Arduino, responsável por efetuar a leitura dos sensores.
|
|
|
|
|
|
Existem duas opções para efetuar a instalação:
|
|
|
|
|
|
* 1ª Opção) Via linha de comando:
|
|
|
```
|
|
|
$ make bu
|
|
|
```
|
|
|
Para maiores detalhes, ou em caso de erro, confira a wiki [terminal-build](terminal-build).
|
|
|
|
|
|
* 2ª Opção) [Utilizar a IDE do Arduino](https://git.cta.if.ufrgs.br/meteorolog/arduino-meteorolog/wikis/instalation-breakdown#2-instale-o-firmware-na-placa).
|
|
|
|
|
|
Tendo instalado o firmware, você pode testar a leitura dos sensores enviando comandos para a serial de acordo com a wiki [serial-commands](serial-commands).
|
|
|
|
|
|
Presente na pasta raiz do projeto, esse arquivo contém todas as configurações necessárias para uso de todos os softwares inclusos no projeto.
|
|
|
### 3. Configure o arquivo `settings.yaml`
|
|
|
|
|
|
Presente na pasta raiz do projeto, esse arquivo contém todas as configurações necessárias para uso do **logger** (software para coleta de dados).
|
|
|
|
|
|
Em resumo, certifique-se de revisar pelo menos os seguintes intens:
|
|
|
|
|
|
| Valor | Descrição breve |
|
|
|
| --------------------- | -------------------------------------------------------------- |
|
|
|
| `SERVER/API_POST_URL` | Substitua `BID` pelo ID da sua placa conforme cadastrada em [dados.cta.if.ufrgs.br/emm](http://dados.cta.if.ufrgs.br/emm). |
|
|
|
| `SERVER/API_POST_URL` | Substitua `BID` pelo ID da sua placa conforme cadastrada em [dados.cta.if.ufrgs.br/emm](http://dados.cta.if.ufrgs.br/emm) |
|
|
|
| `LOGGER/SENSORS` | Sensores cuja leitura será solicitada pelo logger. |
|
|
|
| `LOGGER/INTERVAL` | Intervalo de tempo entre as execuções do logger. |
|
|
|
| `ARDUINO/SERIAL_PORT` | Lista de uma ou mais portas seriais para tentar conexão. |
|
|
|
| `ARDUINO/BOARD_MODEL` | Modelo da placa Arduino de acordo com [tools/ino-models.txt](https://git.cta.if.ufrgs.br/meteorolog/arduino-meteorolog/blob/master/tools/ino-models.txt). |
|
|
|
|
|
|
### 3. Instalação completa
|
|
|
|
|
|
Tendo a placa placa conectada na porta USB conforme em `settings.yaml`, usuários de Linux baseado em Debian (ex: *Ubuntu*, *Mint*, *Debian*, etc) poderão realizar a instalação completa com o único comando:
|
|
|
### 4. Instale o logger
|
|
|
|
|
|
```
|
|
|
$ make install
|
|
|
```
|
|
|
|
|
|
> ATENÇÃO: A instalação pode levar alguns minutos.
|
|
|
|
|
|
Em resumo, este único comando fará os seguintes passos (que você pode executar de maneira independente em caso de falha em alguma dessas etapas):
|
|
|
* Instalará as ferramentas necessárias no sistema (requer senha de root);
|
|
|
```
|
|
|
$ make setup
|
|
|
```
|
|
|
* Compilará e fará upload do firmware para a placa:
|
|
|
```
|
|
|
$ make bu
|
|
|
```
|
|
|
* Requer IDE Arduino instalada, na versão `1.0.x` (veja a wiki [ino-tool](ino-tool) para as possibilidades de utilizar versões mais recentes);
|
|
|
* Alternativamente, você pode pular essa etapa utilizando a [IDE do Arduino](https://git.cta.if.ufrgs.br/meteorolog/arduino-meteorolog/wikis/instalation-breakdown#2-instale-o-firmware-na-placa);
|
|
|
* Criará um daemon (processo de background) para o logger;
|
|
|
```
|
|
|
$ make deploy-logger
|
|
|
```
|
|
|
> ATENÇÃO: A instalação pode levar alguns minutos. Alguns programas serão instalados no sistema (requer senha de administrador). Confira os detalhes na wiki [setup](instalation-breakdown#1-instale-as-ferramentas-de-sistema).
|
|
|
|
|
|
Se tudo deu certo, a última menssagem recebida deverá ser algo como:
|
|
|
|
... | ... | @@ -136,13 +131,17 @@ Se tudo deu certo, a última menssagem recebida deverá ser algo como: |
|
|
meteorologger RUNNING pid 6242, uptime 0:00:02
|
|
|
```
|
|
|
|
|
|
O que significa que o daemon está rodando com sucesso. Você pode desligar a máquina, ou até mesmo desconectar a placa, que o logger continuará sendo executado em background. Quando a placa está disponível, dados serão coletados e armazenados na pasta `data/` (presente na raiz do projeto). Confira a próxima seção sobre monitoramento de dados.
|
|
|
O que significa que o logger está rodando, com sucesso, em background. Assim, você pode desligar a máquina, ou até mesmo desconectar a placa, que o logger continuará sendo executado.
|
|
|
|
|
|
A desinstalação (desativamento do daemon e limpeza do ambiente) é feita com:
|
|
|
Monitore a execução com:
|
|
|
```
|
|
|
$ make uninstall
|
|
|
$ make tail-log
|
|
|
```
|
|
|
> OBS: A pasta `data/` permanece intacta!
|
|
|
|
|
|
* Os dados coletados são validados e armazenados na pasta `data/` (presente na raiz do projeto).
|
|
|
* Valores inválidos são salvos como `NaN`, o que pode significar que ocorreu algum erro numérico na leitura ou que o sensor desta medição não está presente na placa.
|
|
|
* Serão feitas tentativas de envio dos dados para o servidor. Código 200 significa sucesso.
|
|
|
* Em caso de falha, os dados não enviados serão guardados na pasta `data/outgoing` para serem enviados em uma tentativa posterior.
|
|
|
|
|
|
Para maiores detalhes, ou em caso de algum erro, consulte a wiki [instalation-breakdown](instalation-breakdown).
|
|
|
|
... | ... | @@ -168,7 +167,15 @@ $ make plot-data col=<C> |
|
|
```
|
|
|
onde `<C>` deve ser o número da coluna que será plotada no eixo y.
|
|
|
|
|
|
#### Conheça os comandos disponíveis para este projeto com:
|
|
|
#### Conheça todos os comandos para este software com:
|
|
|
```
|
|
|
$ make help-full
|
|
|
``` |
|
|
\ No newline at end of file |
|
|
```
|
|
|
|
|
|
### 5. Desinstalação
|
|
|
|
|
|
A desinstalação (desativamento do logger e limpeza do ambiente) é feita com:
|
|
|
```
|
|
|
$ make uninstall
|
|
|
```
|
|
|
> OBS: A pasta `data/` permanecerá intacta. |
|
|
\ No newline at end of file |