Merge pull request #92 from meshcore-dev/2.2.0

2.2.0-missing

Author: awolden

custom_components/meshcore/config_flow.py

@@ -43,6 +43,7 @@
     CONF_CLIENT_DISABLE_PATH_RESET,
     DEFAULT_CLIENT_UPDATE_INTERVAL,
     CONF_CONTACT_REFRESH_INTERVAL,
+    CONF_DEVICE_DISABLED,
     DEFAULT_CONTACT_REFRESH_INTERVAL,
     CONF_SELF_TELEMETRY_ENABLED,
     CONF_SELF_TELEMETRY_INTERVAL,
@@ -817,6 +818,7 @@ async def async_step_edit_repeater(self, user_input=None):
             repeater[CONF_REPEATER_TELEMETRY_ENABLED] = user_input[CONF_REPEATER_TELEMETRY_ENABLED]
             repeater[CONF_REPEATER_UPDATE_INTERVAL] = user_input[CONF_REPEATER_UPDATE_INTERVAL]
             repeater[CONF_REPEATER_DISABLE_PATH_RESET] = user_input[CONF_REPEATER_DISABLE_PATH_RESET]
+            repeater[CONF_DEVICE_DISABLED] = user_input[CONF_DEVICE_DISABLED]
 
             # Update config entry - deep copy entire data to ensure HA detects changes
             new_data = copy.deepcopy(dict(self.config_entry.data))
@@ -825,7 +827,7 @@ async def async_step_edit_repeater(self, user_input=None):
             self.hass.config_entries.async_update_entry(self.config_entry, data=new_data) # type: ignore
 
             return await self.async_step_init()
-        
+
         # Show current settings
         return self.async_show_form(
             step_id="edit_repeater",
@@ -837,6 +839,7 @@ async def async_step_edit_repeater(self, user_input=None):
                 vol.Optional(CONF_REPEATER_TELEMETRY_ENABLED, default=repeater.get(CONF_REPEATER_TELEMETRY_ENABLED, False)): bool,
                 vol.Optional(CONF_REPEATER_UPDATE_INTERVAL, default=repeater.get(CONF_REPEATER_UPDATE_INTERVAL, DEFAULT_REPEATER_UPDATE_INTERVAL)): vol.All(cv.positive_int, vol.Range(min=MIN_UPDATE_INTERVAL)),
                 vol.Optional(CONF_REPEATER_DISABLE_PATH_RESET, default=repeater.get(CONF_REPEATER_DISABLE_PATH_RESET, False)): bool,
+                vol.Optional(CONF_DEVICE_DISABLED, default=repeater.get(CONF_DEVICE_DISABLED, False)): bool,
             }),
             description_placeholders={
                 "device_name": repeater.get("name", "Unknown")
@@ -861,20 +864,22 @@ async def async_step_edit_client(self, user_input=None):
             # Update client settings
             client[CONF_CLIENT_UPDATE_INTERVAL] = user_input[CONF_CLIENT_UPDATE_INTERVAL]
             client[CONF_CLIENT_DISABLE_PATH_RESET] = user_input[CONF_CLIENT_DISABLE_PATH_RESET]
+            client[CONF_DEVICE_DISABLED] = user_input[CONF_DEVICE_DISABLED]
 
             # Update config entry
             new_data = copy.deepcopy(dict(self.config_entry.data))
             new_data[CONF_TRACKED_CLIENTS] = copy.deepcopy(self.tracked_clients)
             self.hass.config_entries.async_update_entry(self.config_entry, data=new_data) # type: ignore
 
             return await self.async_step_init()
-        
+
         # Show current settings
         return self.async_show_form(
             step_id="edit_client",
             data_schema=vol.Schema({
                 vol.Optional(CONF_CLIENT_UPDATE_INTERVAL, default=client.get(CONF_CLIENT_UPDATE_INTERVAL, DEFAULT_CLIENT_UPDATE_INTERVAL)): vol.All(cv.positive_int, vol.Range(min=MIN_UPDATE_INTERVAL)),
                 vol.Optional(CONF_CLIENT_DISABLE_PATH_RESET, default=client.get(CONF_CLIENT_DISABLE_PATH_RESET, False)): bool,
+                vol.Optional(CONF_DEVICE_DISABLED, default=client.get(CONF_DEVICE_DISABLED, False)): bool,
             }),
             description_placeholders={
                 "device_name": client.get("name", "Unknown")

custom_components/meshcore/const.py

@@ -75,6 +75,9 @@
 CONF_CLIENT_DISABLE_PATH_RESET: Final = "disable_path_reset"
 DEFAULT_CLIENT_UPDATE_INTERVAL: Final = 7200  # 2 hours in seconds
 
+# Device monitoring
+CONF_DEVICE_DISABLED: Final = "disabled"
+
 # Contact refresh interval
 CONF_CONTACT_REFRESH_INTERVAL: Final = "contact_refresh_interval"
 DEFAULT_CONTACT_REFRESH_INTERVAL: Final = 60  # 1 minute in seconds

custom_components/meshcore/coordinator.py

@@ -40,6 +40,7 @@
     CONF_SELF_TELEMETRY_ENABLED,
     CONF_SELF_TELEMETRY_INTERVAL,
     DEFAULT_SELF_TELEMETRY_INTERVAL,
+    CONF_DEVICE_DISABLED,
 )
 from .meshcore_api import MeshCoreAPI
 
@@ -702,7 +703,10 @@ async def _async_update_data(self) -> None:
             if not repeater_config.get('name') or not repeater_config.get('pubkey_prefix'):
                 _LOGGER.warning(f"Repeater config missing name or pubkey_prefix: {repeater_config}")
                 continue
-                
+
+            if repeater_config.get(CONF_DEVICE_DISABLED, False):
+                continue
+
             pubkey_prefix = repeater_config.get("pubkey_prefix")
             repeater_name = repeater_config.get("name")
 
@@ -737,11 +741,14 @@ async def _async_update_data(self) -> None:
         for repeater_config in self._tracked_repeaters:
             if not repeater_config.get('name') or not repeater_config.get('pubkey_prefix'):
                 continue
-                
+
+            if repeater_config.get(CONF_DEVICE_DISABLED, False):
+                continue
+
             telemetry_enabled = repeater_config.get(CONF_REPEATER_TELEMETRY_ENABLED, False)
             if not telemetry_enabled:
                 continue
-                
+
             pubkey_prefix = repeater_config.get("pubkey_prefix")
             repeater_name = repeater_config.get("name")
 
@@ -782,7 +789,10 @@ async def _async_update_data(self) -> None:
             if not client_config.get('name') or not client_config.get('pubkey_prefix'):
                 _LOGGER.warning(f"Client config missing name or pubkey_prefix: {client_config}")
                 continue
-                
+
+            if client_config.get(CONF_DEVICE_DISABLED, False):
+                continue
+
             pubkey_prefix = client_config.get("pubkey_prefix")
             client_name = client_config.get("name")
 

custom_components/meshcore/select.py

@@ -175,11 +175,14 @@ def _get_contact_options(self) -> List[str]:
                 # Format as "Name (pubkey12345)"
                 option = f"{name} ({public_key[:12]})"
                 contact_options.append(option)
-            
+
             # Add a default option if no contacts found
             if not contact_options:
                 return ["No contacts"]
-                
+
+            # Sort alphabetically (case-insensitive)
+            contact_options.sort(key=str.lower)
+
             return contact_options
         except Exception as ex:
             _LOGGER.error(f"Error getting contacts from API: {ex}")
@@ -276,7 +279,7 @@ def _get_discovered_contact_options(self) -> List[str]:
         """Get list of discovered contacts not yet added."""
         all_contacts = self.coordinator.get_all_contacts()
 
-        discovered_options = [SELECT_NO_CONTACTS]
+        discovered_options = []
 
         for contact in all_contacts:
             if not isinstance(contact, dict):
@@ -289,7 +292,11 @@ def _get_discovered_contact_options(self) -> List[str]:
                     option = f"{name} ({pubkey_prefix})"
                     discovered_options.append(option)
 
-        return discovered_options
+        # Sort alphabetically (case-insensitive)
+        discovered_options.sort(key=str.lower)
+
+        # Add placeholder at the beginning
+        return [SELECT_NO_CONTACTS] + discovered_options
 
     @callback
     def _handle_coordinator_update(self) -> None:
@@ -345,7 +352,7 @@ def _get_added_contact_options(self) -> List[str]:
         """Get list of contacts already added to node."""
         all_contacts = self.coordinator.get_all_contacts()
 
-        added_options = [SELECT_NO_CONTACTS]
+        added_options = []
         for contact in all_contacts:
             if not isinstance(contact, dict):
                 continue
@@ -357,7 +364,11 @@ def _get_added_contact_options(self) -> List[str]:
                     option = f"{name} ({pubkey_prefix})"
                     added_options.append(option)
 
-        return added_options
+        # Sort alphabetically (case-insensitive)
+        added_options.sort(key=str.lower)
+
+        # Add placeholder at the beginning
+        return [SELECT_NO_CONTACTS] + added_options
 
     @callback
     def _handle_coordinator_update(self) -> None:

custom_components/meshcore/services.py

@@ -483,6 +483,17 @@ async def async_execute_command_service(call: ServiceCall) -> None:
                     _LOGGER.debug(f"Executing {command_name} with prepared arguments: {prepared_args}")
                     result = await command_method(*prepared_args)
 
+                    # Update coordinator channel info after set_channel
+                    if command_name == "set_channel" and result.type != EventType.ERROR:
+                        channel_idx = prepared_args[0]
+                        # Fetch updated channel info
+                        channel_info_result = await api.mesh_core.commands.get_channel(channel_idx)
+                        if channel_info_result.type != EventType.ERROR:
+                            coordinator._channel_info[channel_idx] = channel_info_result.payload
+                            _LOGGER.info(f"Updated channel {channel_idx} info: {channel_info_result.payload}")
+                            # Trigger coordinator update to refresh select entities
+                            coordinator.async_set_updated_data(coordinator.data)
+
                     # Mark contacts as dirty after add_contact or remove_contact so next ensure_contacts() will sync
                     if command_name == "add_contact" and result.type != EventType.ERROR:
                         api.mesh_core._contacts_dirty = True

docs/docs/messaging.md

@@ -111,6 +111,121 @@ Message activity creates binary sensor entities that track communication:
 - **State**: Always "Active" when messages exist
 - **Attributes**: Public key
 
+## Channel Configuration
+
+Meshcore devices support multiple channels with configurable names and hash-based encryption.
+
+### Hash-Based Channel Encryption
+
+Channels use hash-based encryption where the channel name is hashed to derive the encryption key. Only nodes with the exact channel name can decrypt messages on that channel.
+
+**How it works:**
+- Each channel has a name and a hash derived from that name
+- The hash is used as the encryption key for the channel
+- Only devices configured with the same name+hash combination can communicate
+- You can create private channels by using unique names and sharing them securely
+
+### Setting Channel Names
+
+Use the `set_channel` command to configure channel names:
+
+```yaml
+service: meshcore.execute_command
+data:
+  command: "set_channel 1 #pdx {{ '#pdx' | sha256 | truncate(32, true, '') }}"
+```
+
+**Important**: When using `#` in YAML, the entire command must be quoted (as shown above) since `#` starts a comment in YAML.
+
+#### Command Format
+
+```
+set_channel <channel_idx> <name> <hash>
+```
+
+- **channel_idx**: Channel number (e.g., 0, 1, 2, etc.)
+- **name**: Display name (e.g., `#pdx`, `private`, `work`, `my-secret-channel`)
+- **hash**: SHA256 hash of the channel name, truncated to 32 characters
+
+The template `{{ '#pdx' | sha256 | truncate(32, true, '') }}` automatically generates the correct hash from the name.
+
+**Note**: The `#` prefix is a convention for public/community channels but is not required. You can name channels anything you want.
+
+### Channel Management UI Card
+
+Create a dashboard card to manage your channels:
+
+```yaml
+type: vertical-stack
+cards:
+  - type: markdown
+    content: |
+      ## Channel Configuration
+      Configure channels with hash-based encryption.
+  - type: entities
+    entities:
+      - entity: input_text.meshcore_channel_name
+      - entity: input_number.meshcore_channel_index
+  - type: button
+    name: Set Channel
+    icon: mdi:pound
+    tap_action:
+      action: call-service
+      service: meshcore.execute_command
+      data:
+        command: >
+          set_channel {{ states('input_number.meshcore_channel_index') | int }}
+          {{ states('input_text.meshcore_channel_name') }}
+          {{ states('input_text.meshcore_channel_name') | sha256 | truncate(32, true, '') }}
+```
+
+**Required Helper Entities** (create in Settings → Devices & Services → Helpers):
+
+1. **Channel Index** (Number):
+   - Name: `Meshcore Channel Index`
+   - Entity ID: `input_number.meshcore_channel_index`
+   - Min: 0, Max: 99, Step: 1
+   - Icon: `mdi:numeric`
+
+2. **Channel Name** (Text):
+   - Name: `Meshcore Channel Name`
+   - Entity ID: `input_text.meshcore_channel_name`
+   - Max length: 32
+   - Icon: `mdi:pound`
+
+### Example Channel Configurations
+
+#### Public Channel (Convention: # prefix)
+```yaml
+service: meshcore.execute_command
+data:
+  command: "set_channel 0 #public {{ '#public' | sha256 | truncate(32, true, '') }}"
+```
+
+#### Regional Channel
+```yaml
+service: meshcore.execute_command
+data:
+  command: "set_channel 1 #pdx {{ '#pdx' | sha256 | truncate(32, true, '') }}"
+```
+
+#### Private Channel (Any name)
+```yaml
+service: meshcore.execute_command
+data:
+  command: "set_channel 2 my-secret-channel {{ 'my-secret-channel' | sha256 | truncate(32, true, '') }}"
+```
+
+### Viewing Configured Channels
+
+To see your currently configured channels, use the **MeshCore Channel** select entity:
+- Entity ID: `select.meshcore_channel`
+- Shows all configured channels with their names
+- Displays as "Name (idx)" format (e.g., "#pdx (1)", "work (2)")
+- Updates automatically when channels are configured
+
+Use this select entity in your messaging UI to choose which channel to send to.
+
 ## Message Services
 
 Send messages using these services: