diff --git a/Documentation/applications/industry/abnt_codi/index.rst b/Documentation/applications/industry/abnt_codi/index.rst new file mode 100644 index 00000000000..362e0b1bc05 --- /dev/null +++ b/Documentation/applications/industry/abnt_codi/index.rst @@ -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 +======= ======= ================================================================= diff --git a/Documentation/applications/industry/index.rst b/Documentation/applications/industry/index.rst index 329b56360a9..90c4f6ae4e7 100644 --- a/Documentation/applications/industry/index.rst +++ b/Documentation/applications/industry/index.rst @@ -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