mmrelay 1.1.3__py3-none-any.whl → 1.2.0__py3-none-any.whl

mmrelay/constants/__init__.py

@@ -0,0 +1,54 @@
+"""
+Constants package for MMRelay.
+
+This package organizes all application constants by functional area:
+- app: Application metadata and version information
+- queue: Message queue configuration constants
+- network: Network connection and timeout constants
+- formats: Message format templates and prefixes
+- messages: User-facing strings and templates
+- database: Database-related constants
+- config: Configuration section and key constants
+
+Usage:
+    from mmrelay.constants import queue
+    from mmrelay.constants.app import APP_NAME
+    from mmrelay.constants.queue import DEFAULT_MESSAGE_DELAY
+"""
+
+# Re-export commonly used constants for convenience
+from .app import APP_AUTHOR, APP_NAME
+from .config import (
+    CONFIG_KEY_LEVEL,
+    CONFIG_SECTION_LOGGING,
+    CONFIG_SECTION_MATRIX,
+    CONFIG_SECTION_MESHTASTIC,
+    DEFAULT_LOG_LEVEL,
+)
+from .formats import DEFAULT_MATRIX_PREFIX, DEFAULT_MESHTASTIC_PREFIX
+from .queue import (
+    DEFAULT_MESSAGE_DELAY,
+    MAX_QUEUE_SIZE,
+    QUEUE_HIGH_WATER_MARK,
+    QUEUE_MEDIUM_WATER_MARK,
+)
+
+__all__ = [
+    # App constants
+    "APP_NAME",
+    "APP_AUTHOR",
+    # Config constants
+    "CONFIG_SECTION_MATRIX",
+    "CONFIG_SECTION_MESHTASTIC",
+    "CONFIG_SECTION_LOGGING",
+    "CONFIG_KEY_LEVEL",
+    "DEFAULT_LOG_LEVEL",
+    # Queue constants
+    "DEFAULT_MESSAGE_DELAY",
+    "MAX_QUEUE_SIZE",
+    "QUEUE_HIGH_WATER_MARK",
+    "QUEUE_MEDIUM_WATER_MARK",
+    # Format constants
+    "DEFAULT_MESHTASTIC_PREFIX",
+    "DEFAULT_MATRIX_PREFIX",
+]

mmrelay/constants/app.py

@@ -0,0 +1,29 @@
+"""
+Application metadata constants.
+
+Contains version information, application name, and other metadata
+used throughout the MMRelay application.
+"""
+
+# Application identification
+APP_NAME = "mmrelay"
+APP_AUTHOR = None  # No author directory for platformdirs
+
+# Application display names
+APP_DISPLAY_NAME = "M<>M Relay"
+APP_FULL_NAME = "Meshtastic Matrix Relay"
+
+# Matrix client identification
+MATRIX_DEVICE_NAME = "MMRelay"
+
+# Platform-specific constants
+WINDOWS_PLATFORM = "win32"
+
+# Package and installation constants
+PACKAGE_NAME_E2E = "mmrelay[e2e]"
+PYTHON_OLM_PACKAGE = "python-olm"
+
+# Configuration file names
+CREDENTIALS_FILENAME = "credentials.json"
+CONFIG_FILENAME = "config.yaml"
+STORE_DIRNAME = "store"

mmrelay/constants/config.py

@@ -0,0 +1,78 @@
+"""
+Configuration section and key constants.
+
+Contains configuration section names, key names, and default values
+used throughout the configuration system.
+"""
+
+# Configuration section names
+CONFIG_SECTION_MATRIX = "matrix"
+CONFIG_SECTION_MATRIX_ROOMS = "matrix_rooms"
+CONFIG_SECTION_MESHTASTIC = "meshtastic"
+CONFIG_SECTION_LOGGING = "logging"
+CONFIG_SECTION_DATABASE = "database"
+CONFIG_SECTION_PLUGINS = "plugins"
+CONFIG_SECTION_COMMUNITY_PLUGINS = "community-plugins"
+CONFIG_SECTION_CUSTOM_PLUGINS = "custom-plugins"
+
+# Matrix configuration keys
+CONFIG_KEY_HOMESERVER = "homeserver"
+CONFIG_KEY_ACCESS_TOKEN = (
+    "access_token"  # nosec B105 - This is a config key name, not a hardcoded password
+)
+CONFIG_KEY_BOT_USER_ID = "bot_user_id"
+CONFIG_KEY_PREFIX_ENABLED = "prefix_enabled"
+CONFIG_KEY_PREFIX_FORMAT = "prefix_format"
+
+# Matrix rooms configuration keys
+CONFIG_KEY_ID = "id"
+CONFIG_KEY_MESHTASTIC_CHANNEL = "meshtastic_channel"
+
+# Meshtastic configuration keys (additional to network.py)
+CONFIG_KEY_MESHNET_NAME = "meshnet_name"
+CONFIG_KEY_MESSAGE_INTERACTIONS = "message_interactions"
+CONFIG_KEY_REACTIONS = "reactions"
+CONFIG_KEY_REPLIES = "replies"
+CONFIG_KEY_BROADCAST_ENABLED = "broadcast_enabled"
+CONFIG_KEY_DETECTION_SENSOR = "detection_sensor"
+CONFIG_KEY_MESSAGE_DELAY = "message_delay"
+CONFIG_KEY_HEALTH_CHECK = "health_check"
+CONFIG_KEY_ENABLED = "enabled"
+CONFIG_KEY_HEARTBEAT_INTERVAL = "heartbeat_interval"
+
+# Logging configuration keys
+CONFIG_KEY_LEVEL = "level"
+CONFIG_KEY_LOG_TO_FILE = "log_to_file"
+CONFIG_KEY_FILENAME = "filename"
+CONFIG_KEY_MAX_LOG_SIZE = "max_log_size"
+CONFIG_KEY_BACKUP_COUNT = "backup_count"
+CONFIG_KEY_COLOR_ENABLED = "color_enabled"
+CONFIG_KEY_DEBUG = "debug"
+
+# Database configuration keys
+CONFIG_KEY_PATH = "path"
+CONFIG_KEY_MSG_MAP = "msg_map"
+CONFIG_KEY_MSGS_TO_KEEP = "msgs_to_keep"
+CONFIG_KEY_WIPE_ON_RESTART = "wipe_on_restart"
+
+# Plugin configuration keys
+CONFIG_KEY_ACTIVE = "active"
+CONFIG_KEY_CHANNELS = "channels"
+CONFIG_KEY_UNITS = "units"
+CONFIG_KEY_REPOSITORY = "repository"
+CONFIG_KEY_TAG = "tag"
+
+# Default configuration values
+DEFAULT_LOG_LEVEL = "info"
+DEFAULT_WEATHER_UNITS = "metric"
+DEFAULT_WEATHER_UNITS_IMPERIAL = "imperial"
+DEFAULT_PREFIX_ENABLED = True
+DEFAULT_BROADCAST_ENABLED = True
+DEFAULT_DETECTION_SENSOR = True
+DEFAULT_HEALTH_CHECK_ENABLED = True
+DEFAULT_HEARTBEAT_INTERVAL = 60
+DEFAULT_COLOR_ENABLED = True
+DEFAULT_WIPE_ON_RESTART = False
+
+# E2EE constants
+E2EE_KEY_SHARING_DELAY_SECONDS = 5

mmrelay/constants/database.py

@@ -0,0 +1,22 @@
+"""
+Database-related constants.
+
+Contains default values for database configuration, message retention,
+and data management settings.
+"""
+
+# Message retention defaults
+DEFAULT_MSGS_TO_KEEP = 500
+DEFAULT_MAX_DATA_ROWS_PER_NODE_BASE = 100  # Base plugin default
+DEFAULT_MAX_DATA_ROWS_PER_NODE_MESH_RELAY = 50  # Reduced for mesh relay performance
+
+# Progress tracking
+PROGRESS_TOTAL_STEPS = 100
+PROGRESS_COMPLETE = 100
+
+# Text truncation
+DEFAULT_TEXT_TRUNCATION_LENGTH = 50
+
+# Distance calculations
+DEFAULT_DISTANCE_KM_FALLBACK = 1000  # Fallback distance when calculation fails
+DEFAULT_RADIUS_KM = 5  # Default radius for location-based filtering

mmrelay/constants/formats.py

@@ -0,0 +1,20 @@
+"""
+Message format constants.
+
+Contains default message prefixes, format templates, and other
+formatting-related constants used for message display and relay.
+"""
+
+# Default message prefix formats
+DEFAULT_MESHTASTIC_PREFIX = "{display5}[M]: "
+DEFAULT_MATRIX_PREFIX = "[{long}/{mesh}]: "
+
+# Port number constants for message types
+TEXT_MESSAGE_APP = "TEXT_MESSAGE_APP"
+DETECTION_SENSOR_APP = "DETECTION_SENSOR_APP"
+
+# Emoji flag value
+EMOJI_FLAG_VALUE = 1
+
+# Default channel
+DEFAULT_CHANNEL = 0

mmrelay/constants/messages.py

@@ -0,0 +1,45 @@
+"""
+User-facing messages and string templates.
+
+Contains error messages, log templates, command responses, and other
+strings that are displayed to users or logged.
+"""
+
+# Log configuration defaults
+DEFAULT_LOG_SIZE_MB = 5
+DEFAULT_LOG_BACKUP_COUNT = 1
+LOG_SIZE_BYTES_MULTIPLIER = 1024 * 1024  # Convert MB to bytes
+
+# Numeric constants for comparisons
+PORTNUM_NUMERIC_VALUE = 1  # Numeric equivalent of TEXT_MESSAGE_APP
+DEFAULT_CHANNEL_VALUE = 0
+
+# Message formatting constants
+MAX_TRUNCATION_LENGTH = 20  # Maximum characters for variable truncation
+TRUNCATION_LOG_LIMIT = 6  # Only log first N truncations to avoid spam
+DEFAULT_MESSAGE_TRUNCATE_BYTES = 227  # Default message truncation size
+MESHNET_NAME_ABBREVIATION_LENGTH = 4  # Characters for short meshnet names
+SHORTNAME_FALLBACK_LENGTH = 3  # Characters for shortname fallback
+MESSAGE_PREVIEW_LENGTH = 40  # Characters for message preview in logs
+DISPLAY_NAME_DEFAULT_LENGTH = 5  # Default display name truncation
+
+# Component logger names
+COMPONENT_LOGGERS = {
+    "matrix_nio": ["nio", "nio.client", "nio.http", "nio.crypto", "nio.responses"],
+    "bleak": ["bleak", "bleak.backends"],
+    "meshtastic": [
+        "meshtastic",
+        "meshtastic.serial_interface",
+        "meshtastic.tcp_interface",
+        "meshtastic.ble_interface",
+    ],
+}
+
+# Log level styling
+LOG_LEVEL_STYLES = {
+    "DEBUG": {"color": "cyan"},
+    "INFO": {"color": "green"},
+    "WARNING": {"color": "yellow"},
+    "ERROR": {"color": "red"},
+    "CRITICAL": {"color": "red", "bold": True},
+}

mmrelay/constants/network.py

@@ -0,0 +1,42 @@
+"""
+Network and connection constants.
+
+Contains timeout values, retry limits, connection types, and other
+network-related configuration constants.
+"""
+
+# Connection types
+CONNECTION_TYPE_TCP = "tcp"
+CONNECTION_TYPE_SERIAL = "serial"
+CONNECTION_TYPE_BLE = "ble"
+CONNECTION_TYPE_NETWORK = (
+    "network"  # DEPRECATED: Legacy alias for tcp, use CONNECTION_TYPE_TCP instead
+)
+
+# Configuration keys for connection settings
+CONFIG_KEY_BLE_ADDRESS = "ble_address"
+CONFIG_KEY_SERIAL_PORT = "serial_port"
+CONFIG_KEY_HOST = "host"
+CONFIG_KEY_CONNECTION_TYPE = "connection_type"
+
+# Connection retry and timing
+DEFAULT_BACKOFF_TIME = 10  # seconds
+DEFAULT_RETRY_ATTEMPTS = 1
+INFINITE_RETRIES = 0  # 0 means infinite retries
+MINIMUM_MESSAGE_DELAY = 2.0  # Minimum delay for message queue fallback
+
+# Matrix client timeouts
+MATRIX_EARLY_SYNC_TIMEOUT = 2000  # milliseconds
+MATRIX_MAIN_SYNC_TIMEOUT = 5000  # milliseconds
+MATRIX_ROOM_SEND_TIMEOUT = 10.0  # seconds
+MATRIX_LOGIN_TIMEOUT = 30.0  # seconds
+MATRIX_SYNC_OPERATION_TIMEOUT = 60.0  # seconds
+
+# Error codes
+ERRNO_BAD_FILE_DESCRIPTOR = 9
+
+# System detection
+SYSTEMD_INIT_SYSTEM = "systemd"
+
+# Time conversion
+MILLISECONDS_PER_SECOND = 1000

mmrelay/constants/queue.py

@@ -0,0 +1,17 @@
+"""
+Message queue constants.
+
+Contains configuration values for the message queue system including
+delays, size limits, and water marks for queue management.
+"""
+
+# Message timing constants
+DEFAULT_MESSAGE_DELAY = 2.0  # Firmware-enforced minimum delay in seconds
+
+# Queue size management
+MAX_QUEUE_SIZE = 500
+QUEUE_HIGH_WATER_MARK = int(MAX_QUEUE_SIZE * 0.75)  # 75% of MAX_QUEUE_SIZE
+QUEUE_MEDIUM_WATER_MARK = int(MAX_QUEUE_SIZE * 0.50)  # 50% of MAX_QUEUE_SIZE
+
+# Queue logging thresholds
+QUEUE_LOG_THRESHOLD = 2  # Only log queue status when size >= this value