Asterisk for Home Assistant (app)

About

Asterisk is a Home Assistant app that runs a PBX server for SIP devices such as doorbells and phones. It runs on Home Assistant OS on aarch64 and amd64 systems, and its own page opens in the sidebar. An option can create a phone extension for every person registered in Home Assistant, with numbers generated from 100 and the caller name set to the person's name. Video support can be turned on for those extensions, and extra sound languages can be downloaded at startup. The app can generate a self-signed certificate for its secure interfaces or use a certificate file from the ssl folder. Default Asterisk configuration files are copied out for reference, and customized copies are read from a separate folder. It uses the host network, can reach USB, serial or GPIO devices, and can read and control Home Assistant.

Automatic summary of the docs and configuration of TECH7Fox/asterisk-hass-addons. Something wrong, or are you the maintainer and want your own text here? Get in touch

Supports

Opens in the sidebar Its own page opens inside Home Assistant.
Actively maintained Its author released or pushed a change in the last six months.

Setting it up

Add its app repository under Settings, Apps, then install and start it.

From the docs

Asterisk is a free and open source framework for building communications applications. Asterisk powers IP PBX systems, VoIP gateways, conference servers, and is used by SMBs, enterprises, call centers, carriers and governments worldwide.

From the docs of TECH7Fox/asterisk-hass-addons, MIT License. Shortened.

Permissions

Host networkUses the host's network directly instead of its own.
Hardware accessCan reach USB, serial or GPIO devices.
Home Assistant APICan read and control Home Assistant.

Configuration

AMI PasswordThe password that will be used for the admin user in AMI.
Video SupportEnables videosupport for the auto-added extensions. Video support does not work for the companion app.
Auto Add SecretThe secret set for every auto-added extension. Change this to something secure.
Auto Add ExtensionsWhether to enable the automatic creation of extensions for every person registered in Home Assistant. They will have their number/username auto-generated starting from 100.
Additional Sounds Languages to DownloadThe additional sounds languages to download from https://downloads.asterisk.org/pub/telephony/sounds/ on add-on startup, skipping when already downloaded. Examples: fr, en_GB.
Register Ingress EntryWhether to register the ingress entry for the add-on as a Home Assistant entity or not. This is useful for the SIP card to avoid needing to manually expose Asterisk's WebSockets interface.
Generate SSL CertifcateEnables/disables the generation of a self-signed certificate for use with the SSL interfaces (WSS and TLS).
Certificate FileThe certificate file to use for SSL in your /ssl/ folder, when generate_ssl_cert is disabled.
Private Key FileThe key file to use for SSL in your /ssl/ folder, when generate_ssl_cert is disabled.
Mailbox ServerEnables the mailbox server to send voicemails to the Asterisk mailbox integration.
Mailbox Server PortThe port used by the mailbox server.
Mailbox Server PasswordThe password for the mailbox server.
Mailbox Server ExtensionWhich extension to get the voicemails from.
Google API KeyThe API Key for speech-to-text.
Log LevelThe log level to configure Asterisk to use.