|
| 1 | +"""Sensors.""" |
| 2 | + |
| 3 | +import asyncio |
| 4 | +from collections import defaultdict |
| 5 | +from pathlib import Path |
| 6 | + |
| 7 | +from ha_addon_sunsynk_multi.sensor_options import SENSOR_GROUPS |
| 8 | +from sunsynk import RWSensor, Sensor, SensorDefinitions |
| 9 | +from sunsynk.definitions import import_all_defs |
| 10 | +from sunsynk.utils import pretty_table, table_data |
| 11 | + |
| 12 | + |
| 13 | +async def main() -> None: |
| 14 | + """Generate docs.""" |
| 15 | + all_defs = import_all_defs() |
| 16 | + |
| 17 | + all_defs = {simple_def_name(k): v for k, v in all_defs.items()} |
| 18 | + |
| 19 | + generate_all_sensors(all_defs) |
| 20 | + generate_group_sensors(all_defs) |
| 21 | + |
| 22 | + |
| 23 | +def generate_all_sensors(all_defs: dict[str, SensorDefinitions]) -> None: |
| 24 | + """Generate groups/all.html.""" |
| 25 | + sensors = defaultdict[str, dict[str, Sensor]](dict) |
| 26 | + for name, defs in all_defs.items(): |
| 27 | + for key, sen in defs.all.items(): |
| 28 | + sensors[key][name] = sen |
| 29 | + |
| 30 | + def getname(row: list[Sensor | None]) -> str: |
| 31 | + """Get the name of the row.""" |
| 32 | + for sen in row: |
| 33 | + if sen: |
| 34 | + if isinstance(sen, RWSensor): |
| 35 | + return f"{sen.name} (R/W)" |
| 36 | + return sen.name |
| 37 | + return "?" |
| 38 | + |
| 39 | + def get_sensor_info(sensor: Sensor | None) -> str: |
| 40 | + """Sensor info.""" |
| 41 | + if not sensor: |
| 42 | + return "" |
| 43 | + reg = ( |
| 44 | + str(sensor.address[0]) if len(sensor.address) == 1 else str(sensor.address) |
| 45 | + ) |
| 46 | + return reg |
| 47 | + |
| 48 | + headers = ["Name", *sorted(all_defs)] |
| 49 | + data = table_data(sensors.values(), headers) |
| 50 | + tab = pretty_table( |
| 51 | + *data, to_str=get_sensor_info, calculated_cols={"Name": getname}, wrap_length=0 |
| 52 | + ) |
| 53 | + print(tab.get_string()) |
| 54 | + |
| 55 | + html = tab.get_html_string() |
| 56 | + html = html.replace("<table>", '<table style="overflow-x: unset;" class="bigt">') |
| 57 | + |
| 58 | + Path("www/docs/reference/groups/all.html").write_text( |
| 59 | + html, encoding="utf8", newline="\n" |
| 60 | + ) |
| 61 | + |
| 62 | + |
| 63 | +def simple_def_name(d_name: str) -> str: |
| 64 | + """Shorten the definition name.""" |
| 65 | + return d_name.replace("single-phase", "1PH").replace("three-phase", "3PH") |
| 66 | + |
| 67 | + |
| 68 | +def generate_group_sensors(all_defs: dict[str, SensorDefinitions]) -> None: |
| 69 | + """Generate groups/{name}.yml.""" |
| 70 | + for g_name, s_name_in_group in SENSOR_GROUPS.items(): |
| 71 | + if g_name == "all": |
| 72 | + continue |
| 73 | + g_res = "SENSORS:" |
| 74 | + for s_name in sorted(s_name_in_group): |
| 75 | + # a line per sensor, g_name as a comment |
| 76 | + defs_lst = list[str]() |
| 77 | + for d_name, sdef in all_defs.items(): |
| 78 | + sen = sdef.all.get(s_name) |
| 79 | + if not sen: |
| 80 | + continue |
| 81 | + defs_lst.append(simple_def_name(d_name)) |
| 82 | + if len(defs_lst) == len(all_defs): |
| 83 | + g_res += f"\n - {s_name}" |
| 84 | + else: |
| 85 | + g_res += f"\n - {s_name} # {', '.join(defs_lst)}" |
| 86 | + Path(f"www/docs/reference/groups/{g_name}.yml").write_text( |
| 87 | + g_res, encoding="utf8", newline="\n" |
| 88 | + ) |
| 89 | + |
| 90 | + |
| 91 | +if __name__ == "__main__": |
| 92 | + asyncio.run(main()) |
0 commit comments