Home AssistantHome AssistantContributors

    ↑↓ to moveEnter to openEsc to close
    On this page

    Bashio: plugins

    Bashio functions that wrap the Supervisor API for the plugins next to Home Assistant, the audio server, the CLI, DNS, multicast, and the observer.

    These functions wrap the plugin endpoints of the Supervisor API. Plugins are the containers the Supervisor runs next to Home Assistant for audio, the command line, DNS, multicast, and monitoring. The function lists on this page are generated from the docblocks in the source of Bashio. The descriptions are the ones in the source, so some still say "addon" where this site says app.

    Most of them need hassio_api: true and a role that allows the call, see what your app may call.

    Audio

    The audio server: devices, volume, profiles, and the plugin itself, from /audio. Source: lib/audio.sh.

    • bashio::audio.update: Updates the audio server to the latest version.
      • $1: Version to update to (optional)
    • bashio::audio.reload: Reloads the audio server.
    • bashio::audio.restart: Restarts the audio server.
    • bashio::audio.logs: Returns the logs created by the audio server.
    • bashio::audio.volume: Sets the volume on an audio stream.
      • $1: Stream type ('input' or 'output')
      • $2: Stream index
      • $3: Volume level (a non-negative number where 1.0 is 100%, for example 0.5; values above 1.0 amplify the stream)
      • $4: Apply to the application stream instead of the device (optional)
    • bashio::audio.mute: Mutes or unmutes an audio stream.
      • $1: Stream type ('input' or 'output')
      • $2: Stream index
      • $3: Mute state (true to mute, false to unmute)
      • $4: Apply to the application stream instead of the device (optional)
    • bashio::audio.default: Sets the default audio stream.
      • $1: Stream type ('input' or 'output')
      • $2: Name of the stream to set as default
    • bashio::audio.profile: Activates an audio profile on a card.
      • $1: Card identifier
      • $2: Profile name to activate
    • bashio::audio: Returns a JSON object with generic version information about the audio server.
      • $1: Cache key to store results in (optional)
      • $2: jq Filter to apply on the result (optional)
    • bashio::audio.version: Returns the audio server version used.
    • bashio::audio.version_latest: Returns the latest version of the audio server.
    • bashio::audio.update_available: Checks if there is an update available for the audio server.
    • bashio::audio.host: Returns the host of the audio server.
    • bashio::audio.stats: List all available stats about the audio server.
      • $1: Cache key to store results in (optional)
      • $2: jq Filter to apply on the result (optional)
    • bashio::audio.cpu_percent: Returns CPU usage from the audio server.
    • bashio::audio.memory_usage: Returns memory usage from the audio server.
    • bashio::audio.memory_limit: Returns memory limit from the audio server.
    • bashio::audio.memory_percent: Returns memory usage in percent from the audio server.
    • bashio::audio.network_tx: Returns outgoing network usage from the audio server.
    • bashio::audio.network_rx: Returns incoming network usage from the audio server.
    • bashio::audio.blk_read: Returns disk read usage from the audio server.
    • bashio::audio.blk_write: Returns disk write usage from the audio server.

    CLI

    The CLI plugin, from /cli. Source: lib/cli.sh.

    • bashio::cli.update: Updates the CLI to the latest version.
      • $1: Version to update to (optional)
    • bashio::cli: Returns a JSON object with generic version information about the CLI.
      • $1: Cache key to store results in (optional)
      • $2: jq Filter to apply on the result (optional)
    • bashio::cli.version: Returns the Home Assistant CLI version used.
    • bashio::cli.version_latest: Returns the latest version of the CLI.
    • bashio::cli.update_available: Checks if there is an update available for the CLI.
    • bashio::cli.stats: List all available stats about the CLI.
      • $1: Cache key to store results in (optional)
      • $2: jq Filter to apply on the result (optional)
    • bashio::cli.cpu_percent: Returns CPU usage from the CLI.
    • bashio::cli.memory_usage: Returns memory usage from the CLI.
    • bashio::cli.memory_limit: Returns memory limit from the CLI.
    • bashio::cli.memory_percent: Returns memory usage in percent from the CLI.
    • bashio::cli.network_tx: Returns outgoing network usage from the CLI.
    • bashio::cli.network_rx: Returns incoming network usage from the CLI.
    • bashio::cli.blk_read: Returns disk read usage from the CLI.
    • bashio::cli.blk_write: Returns disk write usage from the CLI.

    DNS

    The DNS plugin: servers, hosts, and the plugin itself, from /dns. Source: lib/dns.sh.

    • bashio::dns.update: Updates the DNS to the latest version.
      • $1: Version to update to (optional)
    • bashio::dns.reset: Reset the DNS.
    • bashio::dns.restart: Restarts the DNS.
    • bashio::dns.options: Sets the DNS plugin options.
      • $1: Options object (JSON)
    • bashio::dns.logs: Returns the logs created by the DNS.
    • bashio::dns: Returns a JSON object with generic version information about the DNS.
      • $1: Cache key to store results in (optional)
      • $2: jq Filter to apply on the result (optional)
    • bashio::dns.host: Returns the Home Assistant DNS host.
    • bashio::dns.version: Returns the current version of the DNS.
    • bashio::dns.version_latest: Returns the latest version of the DNS.
    • bashio::dns.update_available: Checks if there is an update available for the DNS.
    • bashio::dns.locals: Returns a list of local DNS servers used by the DNS.
    • bashio::dns.servers: Returns a list of DNS servers used by the DNS.
    • bashio::dns.stats: List all available stats about the DNS.
      • $1: Cache key to store results in (optional)
      • $2: jq Filter to apply on the result (optional)
    • bashio::dns.cpu_percent: Returns CPU usage from the DNS.
    • bashio::dns.memory_usage: Returns memory usage from the DNS.
    • bashio::dns.memory_limit: Returns memory limit from the DNS.
    • bashio::dns.memory_percent: Returns memory usage in percent from the DNS.
    • bashio::dns.network_tx: Returns outgoing network usage from the DNS.
    • bashio::dns.network_rx: Returns incoming network usage from the DNS.
    • bashio::dns.blk_read: Returns disk read usage from the DNS.
    • bashio::dns.blk_write: Returns disk write usage from the DNS.

    Multicast

    The multicast plugin, from /multicast. Source: lib/multicast.sh.

    • bashio::multicast.update: Updates the Multicast plugin to the latest version.
      • $1: Version to update to (optional)
    • bashio::multicast.restart: Restarts the Multicast plugin.
    • bashio::multicast.logs: Returns the logs created by the Multicast plugin.
    • bashio::multicast: Returns a JSON object with generic information about the Multicast plugin.
      • $1: Cache key to store results in (optional)
      • $2: jq Filter to apply on the result (optional)
    • bashio::multicast.version: Returns the Multicast version used.
    • bashio::multicast.version_latest: Returns the latest version of the Multicast plugin.
    • bashio::multicast.update_available: Checks if there is an update available for the Multicast plugin.
    • bashio::multicast.stats: List all available stats about the Multicast plugin.
      • $1: Cache key to store results in (optional)
      • $2: jq Filter to apply on the result (optional)
    • bashio::multicast.cpu_percent: Returns CPU usage from the Multicast plugin.
    • bashio::multicast.memory_usage: Returns memory usage from the Multicast plugin.
    • bashio::multicast.memory_limit: Returns memory limit from the Multicast plugin.
    • bashio::multicast.memory_percent: Returns memory usage in percent from the Multicast plugin.
    • bashio::multicast.network_tx: Returns outgoing network usage from the Multicast plugin.
    • bashio::multicast.network_rx: Returns incoming network usage from the Multicast plugin.
    • bashio::multicast.blk_read: Returns disk read usage from the Multicast plugin.
    • bashio::multicast.blk_write: Returns disk write usage from the Multicast plugin.

    Observer

    The observer plugin, from /observer. Source: lib/observer.sh.

    • bashio::observer.update: Updates the Observer plugin to the latest version.
      • $1: Version to update to (optional)
    • bashio::observer: Returns a JSON object with generic information about the Observer plugin.
      • $1: Cache key to store results in (optional)
      • $2: jq Filter to apply on the result (optional)
    • bashio::observer.version: Returns the Observer version used.
    • bashio::observer.version_latest: Returns the latest version of the Observer plugin.
    • bashio::observer.update_available: Checks if there is an update available for the Observer plugin.
    • bashio::observer.host: Returns the host of the Observer plugin.
    • bashio::observer.stats: List all available stats about the Observer plugin.
      • $1: Cache key to store results in (optional)
      • $2: jq Filter to apply on the result (optional)
    • bashio::observer.cpu_percent: Returns CPU usage from the Observer plugin.
    • bashio::observer.memory_usage: Returns memory usage from the Observer plugin.
    • bashio::observer.memory_limit: Returns memory limit from the Observer plugin.
    • bashio::observer.memory_percent: Returns memory usage in percent from the Observer plugin.
    • bashio::observer.network_tx: Returns outgoing network usage from the Observer plugin.
    • bashio::observer.network_rx: Returns incoming network usage from the Observer plugin.
    • bashio::observer.blk_read: Returns disk read usage from the Observer plugin.
    • bashio::observer.blk_write: Returns disk write usage from the Observer plugin.
    Was this page helpful?

    Edit this pageView history

    Last updated on .