config.py

import logging
from OhmPi.utils import get_platform

from paho.mqtt.client import MQTTv31

_, on_pi = get_platform()
# DEFINE THE ID OF YOUR OhmPi
ohmpi_id = '0001' if on_pi else 'XXXX'
# DEFINE YOUR MQTT BROKER (DEFAULT: 'localhost')
mqtt_broker = 'localhost' if on_pi else 'NAME_YOUR_BROKER_WHEN_IN_SIMULATION_MODE_HERE'
# DEFINE THE SUFFIX TO ADD TO YOUR LOGS FILES
logging_suffix = ''

# OhmPi configuration
OHMPI_CONFIG = {
    'id': ohmpi_id,  # Unique identifier of the OhmPi board (string)
    # 'R_shunt': 2,  # Shunt resistance in Ohms
    # 'Imax': 4800 / 50 / 2,  # Maximum current
    # 'coef_p2': 2.50,  # slope for current conversion for ADS.P2, measurement in V/V
    # 'nb_samples': 20,  # Max value 10 # was named integer before...
    # 'version': 2,  # Is this still needed?
    # 'max_elec': 64,
    # 'board_addresses': {'A': 0x73, 'B': 0x72, 'M': 0x71, 'N': 0x70},  # CHECK IF YOUR BOARDS HAVE THESE ADDRESSES
    'settings': 'ohmpi_settings.json',  # INSERT YOUR FAVORITE SETTINGS FILE HERE
    # 'board_version': 'mb.2023.0.0',#,'22.10',
    # 'mcp_board_address': 0x20
}  # TODO: add a dictionary with INA models and associated gain values

"""HARDWARE_CONFIG = {
    'controller': {'model' : 'raspberry_pi_3'
                   },
    'tx' : {'model' : 'mb_2024_rev_0_0',
             'mcp_board_address': 0x20,
             'Imax': 4800 / 50 / 2,  # Maximum current
             'R_shunt': 2  # Shunt resistance in Ohms
            },
    'rx' : {'model': 'mb_2024_rev_0_0',
             'coef_p2': 2.50,  # slope for current conversion for ADS.P2, measurement in V/V
             'nb_samples': 20,  # Max value 10 # was named integer before...
            },
    'mux': {'model' : 'mux_2021',
             'max_elec': 64,
             'board_addresses': {'A': 0x73, 'B': 0x72, 'M': 0x71, 'N': 0x70},  # CHECK IF YOUR BOARDS HAVE THESE ADDRESSES
             'coef_p2': 2.50,  # slope for current conversion for ADS.P2, measurement in V/V
             'nb_samples': 20  # Max value 10 # was named integer before...
            }
}"""

HARDWARE_CONFIG = {
    'controller': {'model' : 'dummy_controller'
                   },
    'tx' : {'model' : 'dummy_tx',
             'Imax': 4800 / 50 / 2,  # Maximum current
             'R_shunt': 2  # Shunt resistance in Ohms
            },
    'rx' : {'model': 'dummy_rx',
            },
    'mux': {'model' : 'dummy_mux',
             'max_elec': 64,
             'voltage_max' : 100,
             'current_max' : 3
            }
}
# SET THE LOGGING LEVELS, MQTT BROKERS AND MQTT OPTIONS ACCORDING TO YOUR NEEDS
# Execution logging configuration
EXEC_LOGGING_CONFIG = {
    'logging_level': logging.INFO,
    'log_file_logging_level': logging.DEBUG,
    'logging_to_console': True,
    'file_name': f'exec{logging_suffix}.log',
    'max_bytes': 262144,
    'backup_count': 30,
    'when': 'd',
    'interval': 1
}

# Data logging configuration
DATA_LOGGING_CONFIG = {
    'logging_level': logging.INFO,
    'logging_to_console': True,
    'file_name': f'data{logging_suffix}.log',
    'max_bytes': 16777216,
    'backup_count': 1024,
    'when': 'd',
    'interval': 1
}

# State of Health logging configuration (For a future release)
SOH_LOGGING_CONFIG = {
    'logging_level': logging.INFO,
    'logging_to_console': True,
    'file_name': f'soh{logging_suffix}.log',
    'max_bytes': 16777216,
    'backup_count': 1024,
    'when': 'd',
    'interval': 1
}

# MQTT logging configuration parameters
MQTT_LOGGING_CONFIG = {
    'hostname': mqtt_broker,
    'port': 1883,
    'qos': 2,
    'retain': False,
    'keepalive': 60,
    'will': None,
    'auth': {'username': 'mqtt_user', 'password': 'mqtt_password'},
    'tls': None,
    'protocol': MQTTv31,
    'transport': 'tcp',
    'client_id': f'{OHMPI_CONFIG["id"]}',
    'exec_topic': f'ohmpi_{OHMPI_CONFIG["id"]}/exec',
    'exec_logging_level': logging.DEBUG,
    'data_topic': f'ohmpi_{OHMPI_CONFIG["id"]}/data',
    'data_logging_level': DATA_LOGGING_CONFIG['logging_level'],
    'soh_topic': f'ohmpi_{OHMPI_CONFIG["id"]}/soh',
    'soh_logging_level': SOH_LOGGING_CONFIG['logging_level']
}

# MQTT control configuration parameters
MQTT_CONTROL_CONFIG = {
    'hostname': mqtt_broker,
    'port': 1883,
    'qos': 2,
    'retain': False,
    'keepalive': 60,
    'will': None,
    'auth': {'username': 'mqtt_user', 'password': 'mqtt_password'},
    'tls': None,
    'protocol': MQTTv31,
    'transport': 'tcp',
    'client_id': f'{OHMPI_CONFIG["id"]}',
    'ctrl_topic': f'ohmpi_{OHMPI_CONFIG["id"]}/ctrl'
}