Skip to main content

Overview

The Meshcore Home Assistant integration provides UI components and helper entities for building custom dashboards.

Helper Entities​

The integration creates helper entities for UI interactions:

  • select.meshcore_recipient_type - Choose between Channel or Contact
  • select.meshcore_channel - Select channel (0-3)
  • select.meshcore_contact - Select from available contacts
  • text.meshcore_message - Message input field
  • text.meshcore_command - Command input field

Basic UI Components​

Messaging Card​

A complete messaging interface for sending messages to channels or contacts:

type: vertical-stack
cards:
  - type: entities
    title: MeshCore Messaging
    entities:
      - entity: select.meshcore_recipient_type
        name: Send To
  - type: conditional
    conditions:
      - entity: select.meshcore_recipient_type
        state: Channel
    card:
      type: entities
      entities:
        - entity: select.meshcore_channel
          name: Channel
  - type: conditional
    conditions:
      - entity: select.meshcore_recipient_type
        state: Contact
    card:
      type: entities
      entities:
        - entity: select.meshcore_contact
          name: Contact
  - type: entities
    entities:
      - entity: text.meshcore_message
        name: Message
  - show_name: true
    show_icon: true
    type: button
    name: Send Message
    icon: mdi:send
    tap_action:
      action: call-service
      service: meshcore.send_ui_message
    icon_height: 24px

Command Interface​

Execute Meshcore commands directly from the UI:

type: vertical-stack
cards:
  - type: entities
    entities:
      - entity: text.meshcore_command
        name: MeshCore Command
  - show_name: true
    show_icon: true
    type: button
    tap_action:
      action: call-service
      service: meshcore.execute_command_ui
    name: Execute Command
    icon: mdi:console
    icon_height: 24px

CLI Console​

The execute_command / execute_command_ui services run a command but the response is only visible in Developer Tools or the logs. The CLI Console gives you an interactive terminal-style surface that shows the output of each command directly on the dashboard. See the CLI Command Reference for what you can type.

Enable it first under Settings → Devices & Services → MeshCore → Configure → Global Settings → Enable CLI Console. That creates a sensor.*_cli_console entity whose transcript attribute holds a rolling log of the commands you run and their responses (it records only command/response pairs — it does not stream the radio's continuous diagnostic/noise-floor output), plus two compact button entities: CLI Run Command and CLI Clear Console.

These entities are intentionally hidden by default and not shown on the device page — the console only works as a dashboard card (a device page can't render the transcript), so you reference them by entity_id in the card below. Find the exact ids in Developer Tools → States (filter cli).

The recommended card puts the input and the button entities in a single entities card (compact rows) so you don't get the oversized button card, then renders the transcript with a markdown card:

type: vertical-stack
cards:
  - type: entities
    entities:
      - entity: text.meshcore_command
        name: Command
      - entity: button.YOUR_NODE_cli_run
        name: Run
      - entity: button.YOUR_NODE_cli_clear
        name: Clear
  - type: markdown
    content: |
      ```
      {{ state_attr('sensor.YOUR_NODE_cli_console', 'transcript') }}
      ```

Notes:

  • Replace YOUR_NODE with your node's prefix (e.g. meshcore_49d715_…) — find the exact ids in Developer Tools → States (filter cli).
  • The markdown content uses a literal block (|), not a folded one (>-); a folded scalar collapses the newlines and renders the transcript on one line.
  • Prefer the button entities over a type: button card — the button card renders as a large full-width tile, while the entity rows are compact.

Placing it on the right​

The console lives on a dashboard, not the auto-generated device page (a device page can't render the transcript card or control placement). For a console on the right, use a two-column sections view or a horizontal-stack, and put the vertical-stack above in the right column.

You can also call the services directly with a command, e.g. from an automation or script:

action: meshcore.execute_command
data:
  command: get_stats_radio
  record_to_console: true

Network Map​

Display all Meshcore contacts on a map using their location data.

Requirements:

type: custom:auto-entities
filter:
  include:
    - integration: meshcore
      entity_id: binary_sensor.meshcore_*_contact
      options:
        label_mod: icon
card:
  type: map
  default_zoom: 15
  label_mode: icon

Features:

  • Automatically shows contacts with GPS location
  • Icons indicate node type (client, repeater, room server)
  • Real-time location updates
  • Adjustable zoom level

Contact List Cards​

Simple Contact List​

Display all contacts with their status:

type: custom:auto-entities
filter:
  include:
    - integration: meshcore
      entity_id: binary_sensor.meshcore_*_contact
card:
  type: entities
  title: Mesh Contacts

Contact Grid​

Display contacts in a grid layout:

type: custom:auto-entities
filter:
  include:
    - integration: meshcore
      entity_id: binary_sensor.meshcore_*_contact
card:
  type: grid
  columns: 3
  square: false

Status Cards​

Device Status​

Monitor your Meshcore device status:

type: entities
title: Meshcore Status
entities:
  - entity: sensor.meshcore_abc123_battery_voltage_mynode
  - entity: sensor.meshcore_abc123_battery_percentage_mynode
  - entity: sensor.meshcore_abc123_node_count_mynode
  - entity: sensor.meshcore_abc123_tx_power_mynode

Network Statistics​

Track repeater network performance:

type: entities
title: Network Stats
entities:
  - entity: sensor.meshcore_abc123_repeater1_messages_received
  - entity: sensor.meshcore_abc123_repeater1_messages_sent
  - entity: sensor.meshcore_abc123_repeater1_airtime_utilization
  - entity: sensor.meshcore_abc123_repeater1_noise_floor

Message History​

Recent Messages Card​

Display message history using the logbook:

type: custom:auto-entities
card:
  type: logbook
filter:
  include:
    - entity_id: binary_sensor.meshcore_*_messages
  exclude: []

If you wish you can limit this view for each of your channels. For this you need the following card.

type: logbook
visibility:
  - condition: state
    entity: select.meshcore_channel
    state: Public (0)
target:
  entity_id:
    - binary_sensor.meshcore_696e4b_ch_0_messages

You need to duplicate this card for each channel you have. When you select a channel in the message card you logbook focus will be automaticly on the correct channel. Make sure that visibility and target are in line.

Dashboard Examples​

For complete dashboard configurations, see:

  • Basic Node - Main node dashboard with messaging and monitoring
  • Basic Repeater - Detailed repeater statistics and performance

Tips for UI Development​

  1. Use Conditional Cards: Show/hide elements based on state
  2. Auto-entities: Automatically discover and display Meshcore entities
  3. Custom Icons: Use MDI icons for better visualization
  4. Grid Layouts: Organize cards for different screen sizes
  5. Template Sensors: Create custom sensors for complex data

Mobile Optimization​

For mobile-friendly dashboards:

type: vertical-stack
cards:
  - type: custom:mushroom-chips-card
    chips:
      - type: entity
        entity: sensor.meshcore_contact_count
      - type: entity
        entity: sensor.meshcore_battery_percentage
  - type: custom:swipe-card
    cards:
      # Your message cards here