Documentation: migrate industry/abnt_codi readme

This commit is contained in:
raiden00pl 2023-10-23 11:21:58 +02:00 committed by Xiang Xiao
parent af8548097f
commit bca2a7925c
2 changed files with 38 additions and 1 deletions

View File

@ -0,0 +1,31 @@
=========
abnt_codi
=========
The ABNT CODI is an old energy meter standard used in Brazil.
This code interprets the end user serial output existent in the energy meter.
That output externalizes its data blinking an LED as a serial protocol at the
baudrate of ``110 BPS`` and uses ``8`` octects:
======= ======= =================================================================
Octet Bits Description
======= ======= =================================================================
``001`` ``0-7`` Number of seconds to the end of current active demand (``LSB``)
``002`` ``0-3`` Number of seconds to the end of current active demand (``MSB``)
``4`` Bill indicator. It is inverted at each demand replenishment
``5`` Reactive Interval Indicator. Inverted at end react interval
``6`` If ``1`` means the reactive-capacitive is used to calculate ``UFER``
``7`` If ``1`` means the reactive-inductive is used to calculate ``UFER``
``003`` ``0-3`` Current seasonal segment: ``0001`` tip, ``0010`` out of tip, ``1000`` reserved
``4-5`` Type of charging indicator (flag): ``00`` Blue, ``01`` Green, ``10`` Irrigators, ``11`` Other
``6`` Not used
``7`` If equal ``1`` means reactive rate is enabled
``004`` ``0-7`` Number of pulses for active energy of cur dem interv (``LSB``)
``005`` ``0-6`` Number of pulses for active energy of cur dem interv (``MSB``)
``7`` Not used
``006`` ``0-7`` Number of pulses for reactive energy of cur dem interv (``LSB``)
``007`` ``0-6`` Number of pulses for reactive energy of cur dem interv (``MSB``)
``7`` Not used
``008`` ``0-7`` Inverted bits of _xor_ from previous octects
======= ======= =================================================================

View File

@ -2,7 +2,13 @@
Industrial Applications
=======================
- abnt_codi
.. toctree::
:glob:
:maxdepth: 3
:titlesonly:
abnt_codi/index.rst
- foc - Field Oriented Control user-space library
- scpi - SCPI instrument side parser
- modbus - Modbus support using FreeModbus