Skip to content

Latest commit

 

History

History
84 lines (55 loc) · 4.02 KB

DOCS.md

File metadata and controls

84 lines (55 loc) · 4.02 KB

Home Assistant Add-on: Asterisk

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.

Installation

Follow these steps to get the add-on installed on your system:

  1. Click here:

    Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.

  2. Scroll down the page to find the new repository, and click in the new add-on named Asterisk.

  3. Click in the INSTALL button.

Using

  1. The certificate to your registered domain should already be created via the Duck DNS or Let's Encrypt add-on or another method. Make sure that the certificate files exist in the /ssl/ directory.
  2. Check the add-on configuration by going to the Configuration tab. You need to at least fill the AMI Password and the Auto add secret (if you leave Auto add extensions enabled).
  3. Start the add-on by clicking in the START button.

Note: Remember to restart the add-on when the configuration is changed.

Option: ami_password

Set's the password for the Asterisk Manager Interface, to connect to the Asterisk integration.

Option: video_support

Enables video support for the auto generated extensions.

Option: auto_add

Creates a extension for every person registered in Home Assistant. They will have their number and username auto-generated starting from 100, with the callerid set to the person's name.

Option: auto_add_secret

The secret for the auto generated extensions.

Option: generate_ssl_cert

Enables/disables the generation of a self-signed certificate for use with the SSL interfaces (WSS and TLS).

Option: certfile

The certificate file to use for SSL in your /ssl/ folder, when generate_ssl_cert is disabled.

Option: keyfile

The key file to use for SSL in your /ssl/ folder, when generate_ssl_cert is disabled.

Option: mailbox_server

Enables the mailbox server to send voicemails to the Asterisk mailbox integration.

Option: mailbox_port

The port used by the mailbox server.

Option: mailbox_password

The password for the mailbox server.

Option: mailbox_extension

Which extension to get the voicemails from.

Option: api_key

The API Key for speech-to-text. You can get a key here. Google says it's free, but requires a billing account.

Option: log_level

The log level to configure Asterisk to use. To know more about the existing presets, check logger.conf.

Configuring the Asterisk integration

  • Host: localhost
  • Port: 5038
  • Username: admin
  • Password: whatever you set in the AMI Password configuration

Configuring the SIP.js card

  • Host: localhost
  • Port: 8089
  • Video: false Video is not working at the moment, this will be fixed soon. For now you could use the camera entity instead.

And add a extension. To see which extension every person has, you can look at /config/asterisk/sip_default.conf.

Wiki

For more information, visit the SIP-HASS docs.

Troubleshoot

If you are having problems with the add-on, try deleting the asterisk folder located at /config/ and restart the add-on. This will make sure you have the latest configuration files.