README 1.69 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
***************
EMM Data Logger
***************

    This applications retrieves meteorological data from Arduino boards of the project EMM, save them locally and also sent them to a remote server. 

    More details on the wiki:
        https://git.cta.if.ufrgs.br/meteorolog/logger/wikis/home

    The root directory of this repo contains a Makefile with several commands for easy installation and usage of the software. Make sure to be on this directory when executing commands `make <target>`.

Usage
=====

    The following topics describe the order of the tasks needed to install and use the software along with the Arduino board.


* 1 -- Install system dependencies and prepare local Python execution environment:

    $ make setup

  PS: Uses apt for Debian packages and Python's pip3 will be installed if not present.


* 2 -- Install firmware on the Arduino board via Arduino IDE or the terminal (through Ino Tool) with:

    $ make firmware

  PS: Stil requires Arduino IDE to be installed.


* 3 -- Test the firmware by sending commands (strings) to the serial port via Arduino IDE Serial Monitor or a Python session on the terminal with:

    $ make serial

  Refer to the documentation for all available commands:
    https://git.cta.if.ufrgs.br/meteorolog/logger/wikis/BoardCommands


* 4 -- Prepare the file `settings.ini` with desired behavior and required fields, such as `BOARD_HASH`.


* 5 -- Test the logger execution on the foreground with:

    $ make run

  Data will be saved on the `data/` subdirectory.


* 6 -- Install the logger for background execution and automatic initiation:

    $ make deploy


* 7 -- You can monitor the last generated data or log with:|

    $ make tail-log
    $ make tail-data