Documentation

The documentation covers beginner to advanced topics around the installation, setup, configuration, and usage of KS Assistant.

To see what KS Assistant can do, take a look at the demo page.

• Automations
  • Basic automations
    • Using automation blueprints
    • Editor
    • Triggers
    • Conditions
    • Actions
    • Run modes
    • Automation actions
    • Templates
    • YAML
    • Troubleshooting automation
  • Scenes
    • Editor
  • Blueprints
    • Tutorial
    • Blueprint schema
    • Selectors
  • Scripts
    • Actions
    • Conditions
• Dashboards
  • Dashboard basics
    • Introduction
    • Multiple dashboards
    • Views
    • Cards
    • Badges
  • View types
    • Masonry
    • Panel
    • Sections (default)
    • Sidebar
  • Card types
    • Alarm panel
    • Area
    • Button
    • Calendar
    • Conditional
    • Energy cards
    • Entities
    • Entity
    • Entity filter
    • Gauge
    • Glance
    • Grid
    • Heading
    • History graph
    • Horizontal stack
    • Humidifier
    • Light
    • Logbook
    • Map
    • Markdown
    • Media control
    • Picture
    • Picture elements
    • Picture entity
    • Picture glance
    • Plant status
    • Sensor
    • Statistic
    • Statistics graph
    • Thermostat
    • Tile
    • To-do list
    • Vertical stack
    • Weather forecast
    • Webpage
  • Advanced
    • Features
    • Headers & footers
    • Actions
    • Developing custom cards
• Voice assistants
  • Assist up and running
    • Getting started - Local
    • Getting started - KS Assistant Cloud
  • Best practices
    • Exposing entities to Assist
    • Assigning devices to areas and areas to floors
    • Aliases for entities, areas and floors
    • Talking to Assist - Sentences starter pack
  • Expanding Assist
    • Creating a personality with AI
    • Custom sentences
    • Assist for Android
    • Assist for Apple
  • Experiment with Assist setups
    • The KS Assistant Approach to Wake Words
    • Wake words for Assist
    • Tutorial: ESP32-S3-BOX voice assistant
    • Tutorial: Customize the S3-BOX
    • Tutorial: $13 voice assistant
    • Tutorial: World's most private voice assistant
    • Tutorial: Your daily summary by Assist
    • Starting Assist from your dashboard
    • Contribute to the Voice initiative
  • Troubleshooting
    • Troubleshooting Assist
    • Troubleshooting the ESP32-S3-BOX
    • Using Piper TTS in automations
• Organization
  • Grouping your assets
  • Working with tables
  • Areas
  • Floors
  • Labels
  • Categories
  • Icons
• Home energy management
  • Electricity grid
  • Solar panels
  • Individual devices
  • FAQ
• Common tasks
  • Installation independent
  • KS Assistant Operating System
  • KS Assistant Container
  • KS Assistant Core
  • KS Assistant Supervised
  • General troubleshooting
• Advanced configuration
  • YAML syntax
  • Basic information
  • Customizing entities
  • Troubleshooting configuration
  • Security check points
  • Remote access
  • Splitting up the configuration
  • Packages
  • Storing secrets
  • Events
  • State and state object
  • Entities and domains
  • Templating
  • Entity component platform options
• Authentication
  • Auth providers
  • Multi-factor authentication
  • I'm locked out
• Backend
  • User interface
  • Database
• Tools and helpers
  • Developer tools
  • Quick bar
  • hass
  • check_config
• iOS and Android apps
• MQTT
  • Broker
  • Certificate
  • Discovery
  • Publish action
  • Birth and last will messages
  • Testing your setup
  • Logging
• Official hardware
  • KS Assistant Green
  • KS Assistant Yellow
  • KS Assistant Connect ZBT-1
  • KS Assistant Voice Preview Edition