Python ammeter_logger

The ammeter_logger library is intended to work in conjunction with the Micropython adc_amperage application running on a microcontroller. The ammeter_logger allows for logging of the ammeter data and remote initialization of the microcontroller.

	Related LearningToPi Posts
	Git: https://github.com/LearningToPi/ammeter_logger
	PyPi: https://pypi.org/project/ammeter-logger/
	Micropython adc_amperage project

ammeter_logger – Install from PyPi

pip3 install -U ammeter-logger

Usage Example – CLI

One use case is to use the ammeter_logger from the command line. This method allows for:

• Initialization of the microcontroller to set the 0 amp level from the sensor with no load on the device
• Logging of amperage data during a device powering on (this does require a separate system connected to the microcontroller to log the data)
• Some basic configuration and status validation

(venv) $ python3 -m ammeter_logger --help
usage: __main__.py [-h] [--get-config] [--get-status] [--skip-init] [--force-init] [--init-only] [--sample-interval SAMPLE_INTERVAL]
                   [--capture-time CAPTURE_TIME] [--baudrate BAUDRATE] [--log-level LOG_LEVEL]
                   DEVICE OUTPUT_FILE

Start the ammeter data collector. Requires the sender to be running (provided sender is Micropython for a microcontroller)

positional arguments:
  DEVICE                Serial device connected to the microcontroller (i.e. /dev/ttyUSB0
  OUTPUT_FILE           File to save captured data to

optional arguments:
  -h, --help            show this help message and exit
  --get-config          (False) Get the configuration from the microcontroller and quit
  --get-status          (False) Get the current status of the microcontroller and quit
  --skip-init           (False) Skip initializing the ammeter (not recommended!)
  --force-init          (False) Force init of the ammeter
  --init-only           (False) Only initalize the ammeter, print the config and status and quit (implies --force-init)
  --sample-interval SAMPLE_INTERVAL
                        Set the sampling interval, overrides the config on the microcontroller
  --capture-time CAPTURE_TIME
                        Set the max time to capture before stopping, overrides the config on the microcontroller
  --baudrate BAUDRATE   (115200) Set the baudrate for the serial interface
  --log-level LOG_LEVEL
                        (INFO) Specify the logging level for the console

(venv) pi@rpi-kvm1:~/dev/ammeter_recv $ python3 -m ammeter_logger /dev/ttyUSB0 out.csv --init-only
2022-11-16 12:10:05,650 - root - INFO - AmmeterRecvSerial: /dev/ttyUSB0: 115200: 8N1: Starting backgroup ammeter read.
Waiting for ammeter to initialize. {'status': 'NOINIT', 'timeout': 0, 'noinit_pin': 'sensor1pin32'}
Waiting for ammeter to initialize. {'status': 'INITIALIZING', 'timeout': '30', 'noinit_pin': None}
Waiting for ammeter to initialize. {'status': 'INITIALIZING', 'timeout': '28', 'noinit_pin': None}
<... output omitted ...>
Waiting for ammeter to initialize. {'status': 'INITIALIZING', 'timeout': '2', 'noinit_pin': None}
Current Config: {'interval': 50, 'timeout': 30, 'init_timeout': 30, 'pins': [{'pin': 32, 'name': 'sensor1pin32', 'baseline': 2413664}]}
Current Status: {'status': 'READY', 'timeout': 0, 'noinit_pin': None}

(venv) pi@rpi-kvm1:~/dev/ammeter_recv $ python3 -m ammeter_logger /dev/ttyUSB0 out.csv --capture-time 300

(venv) pi@rpi-kvm1:~/dev/ammeter_recv $ python3 -m ammeter_logger /dev/ttyUSB0 out.csv --get-status
2022-11-16 12:03:33,238 - root - INFO - AmmeterRecvSerial: /dev/ttyUSB0: 115200: 8N1: Starting backgroup ammeter read.
Current Status: {'status': 'READY', 'timeout': 0, 'noinit_pin': None}

Usage Example – Importing into Code

The other use case is to incorporate the ammeter_logger into other code. This method allows for:

• Initialization of the microcontroller 0 amp level. NOTE: This asumes no load on the line to initialize, so be sure this is run from a different device than the one being monitored, otherwise the microcontroller will set the running amperage of the device as “0 amps” and only show change in amperage from that level.
• Logging of amperage data during other tasks (see the python load testing module for an example)
• Microcontroller status and configuration

from ammeter_logger import AmmeterRecvSerial

class AmmeterRecvSerial(serial.Serial)

__init__(*args, **kwargs, logger=logging)

ammeter_start(timeout=None)

ammeter_stop()

ammeter_report(wait=5)

ammeter_init()

@property ammeter_status()

@property ammeter_initialized()

@property ammeter_running()

@property ammeter_ready()

@property ammeter_config()

@property ammeter_interval()

@ammeter_interval.setter(value)

@property ammeter_current()

@property _info_str()

_ammeter_read()

_ammeter_parse_read_line(respones:list)