Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
441 changes: 246 additions & 195 deletions README.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions helpers/doc-generator/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
output
35 changes: 35 additions & 0 deletions helpers/doc-generator/main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
from sun2000_modbus.datatypes import DataType
from sun2000_modbus.registers import InverterEquipmentRegister, BatteryEquipmentRegister, MeterEquipmentRegister


datatype_mapping = {
DataType.STRING: 'String',
DataType.UINT16_BE: 'Number',
DataType.UINT32_BE: 'Number',
DataType.INT16_BE: 'Number',
DataType.INT32_BE: 'Number',
DataType.BITFIELD16: 'Binary String/Bitfield',
DataType.BITFIELD32: 'Binary String/Bitfield',
DataType.MULTIDATA: 'Bytestring',
}


def omit_none(gain) -> str:
if gain:
return gain
return ''

def process_register(register, filename) -> None:
with open(f'output/{filename}', 'w') as inverter_docs:
inverter_docs.write('| Name | Type | Gain | Unit | Access Type |\n')
inverter_docs.write('| :- | :- | :- | :- | :- |\n')
for item in register:
inverter_docs.write(f'| {item.name} | {datatype_mapping[item.value.data_type]} | {omit_none(item.value.gain)} | {omit_none(item.value.unit)} | {item.value.access_type.name} |\n')

def main() -> None:
process_register(InverterEquipmentRegister, 'inverter.md')
process_register(BatteryEquipmentRegister, 'battery.md')
process_register(MeterEquipmentRegister, 'meter.md')

if __name__ == "__main__":
main()
2 changes: 2 additions & 0 deletions helpers/register-parser/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
input
output
Loading