seread 0.1.24

Script to read serial port and store to file/influxdb

* Project seread
 *IN CONSTRUCTION NOW -  VERSION 0.1.23+ now may work*

 /the first goal is to read serial ports and save the data to file and influxdb/

** TL;DR
Try ~./bin_seread -D /dev/ttyACM0 -t 2,10 -c word~ from git directory or

~seread  -D /dev/ttyACM0 -t 2,10 -c word~ from pypi install. Supposing,
you have your device on ~/dev/ttyACM0~

** What it did up to now

 This code managed to read (in the past):
  - ORTEC COUNTER (raw numbes, using script)
  - arduino analog pins A0-An (json going out from arduino)
  - arduino DHT sensor (with json output coded)
  - arduino I2C pressure sensor
  - arduino NTC temperature sensors (preprogrammed)

** Installation

  The project still develops, changes can be made anytime. The actual
 dependencies can be installed by running ~./pipall.py~.

  The code should be run by ~seread~

** Basic usage

*** Parameter -t
 The original aim is to read serial in =Short period= (like 1s or 2s for DHT)
and write to TXT files. Then every  =Long period= (like 60s, 120s) it writes to
influxdb(s) and sends UDP packets (to root acquisition running to display counters)

~seread  -D /dev/ttyACM0 -t 2,10 -c word~

*** Parameter -D or -l
 Device can be defined by the ttyXXX or by location. See what is detected on ~seread~.

** Input/Output files

 *INPUT*
INP_calib="~/.seread.calib"
INP_discover = "~/.seread_discover8086"
INP_permanent = "~/.seread_permanent8086"
INP_influx_cred = "~/.influx_userpassdb"
INP_udp_out = "~/.seread_udp_out"
INP_script = "script"

 - ~/.seread.calib
 - ~/.myservice_discover8086
 - ~/.myservice_permanent8086
 - ~/.influx_userpassdb
 - ~/.sng2_udp
 - script
*OUTPUT*
 - ~/serial_NG2_udp
 - ~/serial_NG2_jso

*** seread.calib
*Calibration after readout*

It is possible to make a calibration after reading the serial values
in json.  Check the file ~~/.seread.calib~

Example:
#+BEGIN_SRC
{
"valuea0":{"a":0.21699,"b":-61.111},
"valuea1":{"a":0.1861328,"b":-40.2}
}
#+END_SRC

Pay attention to commas and double quotes. =valuea0= is the same name
of the analog value exctracted from the arduino, =a= =b= are linear
coefficients.

*** seread_discover8086
    This contains IP - one per line - of PCs with influxdb running
The user, pass, database is in the file  ~~/.influx_userpassdb~
*** udp_out
  lines with IP:PORT or without PORT, then 8080 is assumed. The will be UDP packet
sent to IP:PORT (every long period)
*** script
 this runs one line at a time and repeats the last line forever. The example starts the ORTEC counter


** Options
  - ~-t~ two time periods, read,writeinflux: ~-t time1,time2~
  - ~-i~ ~-influxyes [true|false]~ : send to influx if  ~-i~ is present. Sending will happen on time2: ~-t time1,time2~

** More functions: (in construction)
*** 8099 port server
  /This is Vadim's function/. Information obtained on this port will store data in influxdb.
Vacuum mainly. For the moment, there are several interpreters:

**** influxme
~echo 'influxme [{"measurement":"geo","fields":{"longitude":15.0,"latitude":50.0}}]'~

~for ((i=0;i<10;i++)); do echo 'influxme [{"measurement":"geo","fields":{"longitude":15.0,"latitude":50.$i}}]' ; done~

**** influxmegeo

~echo influxmegeo geo 14.28 49.86 | nc 127.0.0.1  8099~


**** ptz
May need to install some stuff: ~sudo apt-get install python3-smbus~

~echo ptz pan +5 | nc 127.0.0.1 8099~
~echo ptz tilt -5 | nc 127.0.0.1 8099~


** APPENDIX

***  Adding dialout group to be able to work with USB
~sudo usermod -a -G dialout $USER~ then either
reboot of logout/login or try `newgrp dialout` in terminal.



*** Arduino-mode


**** Arduino programming remarks
  Different types need different settings in the original IDE.

  - Chineese NANO
      - Tools/ArduinoNano/ATmega328P(old)/ttyUSB0

  - UNO with shield
      - Tools/ArduinoUNO/__/ACM0 with programmer AVRISM mkII

**** Straight installer in emacs is fast
 - go to (https://github.com/raxod502/straight.el and prepend
 the code to the ~~/.emacs~ to use ~straight-use-package~
 - say M-x ~straight-use-package~ ~arduino-mode~
 - install ~auto-minor-mode~
 - install somehow ~arduino-cli~ from https://github.com/arduino/arduino-cli) and  [package](https://arduino.github.io/arduino-cli/installation/

**** emacs setting

 - copy ~arduino-cli.el~ file from
 https://github.com/motform/arduino-cli-mode to ~~/.emacs.d/lisp/~ and
add ~(add-to-list 'load-path "~/.emacs.d/lisp/")~
and ~(load "arduino-cli.el")~ to ~~/.emacs~.

BUT as now, I cannot compile, as ~--fqbn~ is needed and
 not given automatically.
 - IN EMACS say M-x ~arduino-cli-mode~


The ~~/.emacs~ contents:

#+BEGIN_SRC lisp
(defvar bootstrap-version)
(let ((bootstrap-file
       (expand-file-name "straight/repos/straight.el/bootstrap.el" user-emacs-directory))
      (bootstrap-version 5))
  (unless (file-exists-p bootstrap-file)
    (with-current-buffer
        (url-retrieve-synchronously
         "https://raw.githubusercontent.com/raxod502/straight.el/develop/install.el"
         'silent 'inhibit-cookies)
      (goto-char (point-max))
      (eval-print-last-sexp)))
  (load bootstrap-file nil 'nomessage))
;;
;;
(straight-use-package 'arduino-mode)
(add-to-list 'auto-minor-mode-alist '("\\.ino\\'" . arduino-cli-mode))
;;
(add-to-list 'load-path "~/.emacs.d/lisp/")
(load "arduino-cli.el")

#+END_SRC




**** Arduino-cli commandline
 - ~arduino-cli config init~
 - ~arduino-cli core update-index~
 - ~arduino-cli board list~
 - ~arduino-cli core install arduino:samd~
 - ~arduino-cli core install arduino:avr~
 - ~arduino-cli core list~
 - ~arduino-cli core listall~
 - ~arduino-cli core --fqbn arduino:avr:diecimila  test.ino~

 - ~arduino-cli compile 20200411-logoled-ser1sd0.ino --fqbn arduino:avr:nano~
 and ~arduino-cli upload --fqbn arduino:avr:nano -i 20200411-logoled-ser1sd0.ino.arduino.avr.nano.hex -p /dev/ttyUSB0~
should work


*** readme in org
Pypi has problems with org, see: https://packaging.python.org/specifications/core-metadata/#description-content-type-optional