Skip to content

gridMeter_client_save_data_v9

Created on Sat Oct 25 21:05:19 2025

@author: anura

append_alarm_from_entry_values(entry: dict, regs: dict, *, alarm_json_path: str = os.path.join('emsConfig', 'gridMeter_alarm_code.json'), default_display_name: str = 'Alarm', default_severity: str = 'warning', default_data_type: str = 'BITMAP32', default_registers: int = 2, debug: bool | None = None) -> bool

Use values already read from Modbus (now in entry) to append a normalized alarm block.

Source code in EMS_template_codes/gridMeter_client_save_data_v9.py
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
def append_alarm_from_entry_values(
    entry: dict,
    regs: dict,
    *,
    alarm_json_path: str = os.path.join("emsConfig", "gridMeter_alarm_code.json"),
    default_display_name: str = "Alarm",
    default_severity: str = "warning",
    default_data_type: str = "BITMAP32",
    default_registers: int = 2,
    debug: bool | None = None,
) -> bool:
    """
    Use values already read from Modbus (now in `entry`) to append a normalized alarm block.
    """
    # Resolve debug flag
    if debug is None:
        debug = ('DEBUG' in globals() and bool(globals().get('DEBUG')))

    # (A) Dump all keys containing 'alarm'
    debug_dump_alarm_fields(entry)

    # 1) Find the alarm code in the entry (handles gridMeter_ prefix or bare)
    code_key_candidates = ["gridMeter_alarm_code", "alarm_code","gridMeter_alarms"]
    code_key = next((k for k in code_key_candidates if k in entry), None)
    alarm_code = entry.get(code_key) if code_key else None

    if debug:
        print(f"[DEBUG] alarm_code search keys: {code_key_candidates}")
        print(f"[DEBUG] resolved code_key: {code_key!r}, value: {alarm_code!r}")

    if alarm_code is None or (isinstance(alarm_code, str) and not alarm_code.strip()):
        if debug:
            print("[DEBUG] No alarm_code present in entry; skip alarm append.")
        return False

    # Normalize code to string
    if isinstance(alarm_code, (int, float)):
        alarm_code = str(int(alarm_code))
    else:
        alarm_code = str(alarm_code).strip()

    # 2) Address resolution (prefer explicit entry value; else meta for that register)
    addr_key_candidates = ["gridMeter_alarm_address", "alarm_address"]
    address = None
    for k in addr_key_candidates:
        if k in entry:
            try:
                address = int(entry[k])
                break
            except Exception:
                pass
    if address is None and code_key and code_key in regs:
        try:
            address = int(regs[code_key].get("address"))
        except Exception:
            address = 0
    if address is None:
        address = 0

    # 3) Data type & registers (from meta if available)
    data_type = default_data_type
    registers = default_registers
    if code_key and code_key in regs:
        meta = regs[code_key]
        if isinstance(meta, dict):
            dt = (meta.get("data_type") or default_data_type)
            data_type = str(dt).upper()
            try:
                registers = int(meta.get("registers") or default_registers)
            except Exception:
                registers = default_registers

    if debug:
        print(f"[DEBUG] Using alarm_code={alarm_code}, address={address}, data_type={data_type}, registers={registers}")

    # 4) Load alarm mapping JSON
    try:
        with open(alarm_json_path, "r", encoding="utf-8") as f:
            alarm_map = json.load(f)
    except Exception as e:
        if debug:
            print(f"[DEBUG] Unable to read '{alarm_json_path}': {e}")
        return False
    if not isinstance(alarm_map, dict):
        if debug:
            print(f"[DEBUG] Alarm map in '{alarm_json_path}' is not a dict.")
        return False

    raw = alarm_map.get(alarm_code)
    if raw is None:
        if debug:
            print(f"[DEBUG] Alarm code '{alarm_code}' not found in '{alarm_json_path}'.")
        return False

    # 5) Normalize mapping into display fields
    if isinstance(raw, dict):
        message = raw.get("message") or ""
        alarm_display_name = raw.get("alarm_display_name") or default_display_name
        severity = (raw.get("severity") or default_severity).lower()
    else:
        message = str(raw)
        alarm_display_name = default_display_name
        severity = default_severity

    # 6) Set entry['alarm'] as a SINGLE object (not an array)
    alarm_obj = {
        "active": True,
        "alarm_display_name": alarm_display_name,
        "alarm_code": alarm_code,
        "severity": severity,
        "message": message,
        "acknowledged": "false",
        "address": int(address),
        "data_type": data_type,
        "registers": int(registers),
    }
    entry["alarm"] = alarm_obj  # <-- single dict

    if debug:
        print(f"[DEBUG] set alarm object: {alarm_obj}")

    return True

debug_dump_alarm_fields(entry: dict, rx: dict | list | tuple | None = None)

In DEBUG mode, scan for keys containing 'alarm' (case-insensitive) and print key/value. Checks both entry (already-filled live values) and optional rx payload if provided.

Source code in EMS_template_codes/gridMeter_client_save_data_v9.py
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
def debug_dump_alarm_fields(entry: dict, rx: dict | list | tuple | None = None):
    """
    In DEBUG mode, scan for keys containing 'alarm' (case-insensitive) and print key/value.
    Checks both `entry` (already-filled live values) and optional `rx` payload if provided.
    """
    if not ('DEBUG' in globals() and DEBUG):
        return

    def _scan_mapping(name, m):
        print(f"[DEBUG] --- scanning '{name}' for keys containing 'alarm' ---")
        found = False
        for k, v in (m.items() if isinstance(m, dict) else []):
            if 'alarm' in str(k).lower():
                print(f"[DEBUG] {name}[{k!r}] -> {v!r}")
                found = True
        if not found:
            print(f"[DEBUG] no 'alarm' keys found in {name}")

    # Scan entry (where your live Modbus reads are stored)
    if isinstance(entry, dict):
        _scan_mapping("entry", entry)

    # Optionally scan raw payload too if you pass it in
    if isinstance(rx, dict):
        _scan_mapping("rx", rx)
    elif isinstance(rx, (list, tuple)):
        print("[DEBUG] --- scanning 'rx' list/tuple for alarm-like items ---")
        any_print = False
        for i, item in enumerate(rx):
            if (isinstance(item, str) and 'alarm' in item.lower()) or \
               (isinstance(item, dict) and any('alarm' in str(k).lower() for k in item.keys())):
                print(f"[DEBUG] rx[{i}] -> {item!r}")
                any_print = True
        if not any_print:
            print("[DEBUG] no alarm-like items found in rx")

load_grid_registers()

Returns:

Name Type Description
name_to_meta

dict[str, dict] mapping 'gridMeter_' -> { "address": int, "data_type": "FLOAT32"|"INT32U"|"BITMAP32", "registers": int

}

endianness

"big" or "little"

Source code in EMS_template_codes/gridMeter_client_save_data_v9.py
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
def load_grid_registers():
    """
    Returns:
      name_to_meta: dict[str, dict] mapping 'gridMeter_<name>' -> {
          "address": int,
          "data_type": "FLOAT32"|"INT32U"|"BITMAP32",
          "registers": int
      }
      endianness: "big" or "little"
    """
    with open(GRID_REGISTER_PATH, "r") as f:
        data = json.load(f)

    endianness = "big"
    if isinstance(data, dict) and "read_batches" in data:
        batches = data.get("read_batches") or []
        if batches and isinstance(batches[0], dict):
            endianness = (batches[0].get("endianness") or "big").lower()

    name_to_meta = {}

    if "categories" in data and isinstance(data["categories"], dict):
        cats = data["categories"]
        for _cat, cat in cats.items():
            for section in ("read_only", "read_write"):
                entries = cat.get(section, {})
                for name, meta in entries.items():
                    if not isinstance(meta, dict):
                        continue
                    addr = int(meta.get("address"))
                    dt   = (meta.get("data_type") or "FLOAT32").upper()
                    regs = int(meta.get("registers") or 2)
                    name_to_meta[f"gridMeter_{name}"] = {
                        "address": addr,
                        "data_type": dt,
                        "registers": regs
                    }
    else:
        # Flat style: keys like "active_power_register": 21021
        for key, addr in data.items():
            if key.endswith("_register") and isinstance(addr, int):
                base = key[:-len("_register")]
                name_to_meta[f"gridMeter_{base}"] = {
                    "address": int(addr),
                    "data_type": "FLOAT32",
                    "registers": 2
                }

    if not name_to_meta:
        raise ValueError("No GRID registers found in gridMeter_register.json (flat '*_register' or categories.* expected)")
    return name_to_meta, endianness

read_registers_debug(client: ModbusClient, address: int, count: int)

Wrapper around client.read_holding_registers with optional raw debug dump.

Source code in EMS_template_codes/gridMeter_client_save_data_v9.py
146
147
148
149
150
151
152
153
154
155
def read_registers_debug(client: ModbusClient, address: int, count: int):
    """Wrapper around client.read_holding_registers with optional raw debug dump."""
    regs = client.read_holding_registers(address, count)
    if DEBUG:
        ts = datetime.now().strftime("%H:%M:%S.%f")[:-3]
        if regs is None:
            print(f"[DEBUG {ts}] read_holding_registers(addr={address}, count={count}) -> None")
        else:
            print(f"[DEBUG {ts}] read_holding_registers(addr={address}, count={count}) -> {regs}")
    return regs

read_u16_pair(client: ModbusClient, address: int)

Read two 16-bit holding registers (address, address+1). Returns (hi, lo) or (None, None).

Source code in EMS_template_codes/gridMeter_client_save_data_v9.py
158
159
160
161
162
163
def read_u16_pair(client: ModbusClient, address: int):
    """Read two 16-bit holding registers (address, address+1). Returns (hi, lo) or (None, None)."""
    regs = read_registers_debug(client, address, 2)
    if regs and len(regs) == 2:
        return regs[0] & 0xFFFF, regs[1] & 0xFFFF
    return None, None

🔁 Simulation Flow

flowchart TD
    A[Start main()] --> B[...]

⚙️ Flow with Conditional Checks

flowchart TD
    A[Start main()] --> B{Check something?}
    B -- Yes --> C[Do X]
    B -- No --> D[Exit]