Skip to content

Commit

Permalink
Update README and document call_duration_sec behavior
Browse files Browse the repository at this point in the history
  • Loading branch information
black-roland committed Nov 12, 2024
1 parent b55542e commit 442c3d5
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 17 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@

[![Add custom repository to HACS](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=black-roland&repository=homeassistant-gsm-call&category=integration)

Custom component to make phone calls from Home Assistant using GSM modems.
Home Assistant integraion for making phone calls using 3G/4G modems.

## Installation

This component can be installed using [HACS](https://hacs.xyz/):
This integration can be installed using HACS. Click the blue button above or add repository manually:

1. Go to _HACS__Integrations_.
1. In the top right corner select the 3-dots menu, and choose _Custom repositories_.
Expand All @@ -21,7 +21,7 @@ This component can be installed using [HACS](https://hacs.xyz/):

## Configuration and usage

Use `configuration.yaml` to configure the component:
To use this integration, add the following to your `configuration.yaml`:

```yaml
notify:
Expand All @@ -30,28 +30,32 @@ notify:
device: /dev/serial/by-id/usb-HUAWEI_Technology_HUAWEI_Mobile-if01-port0 # modem device path
```
Make sure to restart Home Assistant afterward and then use `notify.call` service to make a phone call. The phone number to dial is specified as `target`:
Make sure to restart Home Assistant after updating `configuration.yaml`. Use `notify.call` action to make a phone call. The phone number to dial is specified as `target`:

```yaml
action:
service: notify.call
data:
target: "+12345678901"
message: "Required by HASS but not used by integration"
message: "Required by HASS but not used by the integration — enter any text here"
```

### Call duration
### Dialing duration

By default, the call lasts about 25 seconds. This could be changed by specifying `call_duration_sec`:
By default, the integration tries to make a phone call for 30 seconds. Duration can be changed by specifying `call_duration_sec`:

```yaml
notify:
- name: call
platform: gsm_call
device: /dev/serial/by-id/usb-HUAWEI_Technology_HUAWEI_Mobile-if01-port0
call_duration_sec: 45
call_duration_sec: 40
```

Please take in mind that your service provider might interrupt dialing before reaching the desired time if the duration is too high.

The duration is counted from the moment the called phone starts ringing.

## Support for SMS and other features

This integration is intended for making voice calls. Let's keep it simple. There are no plans to add SMS or other functionality not directly related to voice calls. For SMS support, please check out [this integration](https://www.home-assistant.io/integrations/sms/).
Expand Down
22 changes: 13 additions & 9 deletions README.ru.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ See description [in English here](./README.md).

[![Добавить репозиторий в HACS](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=black-roland&repository=homeassistant-gsm-call&category=integration)

Пользовательский компонент для совершения телефонных звонков из Home Assistant с использованием GSM-модема.
Пользовательский компонент для совершения телефонных звонков из Home Assistant с использованием 3G/4G модемов.

## Установка

Этот компонент можно установить с помощью [HACS](https://hacs.xyz/):
Компонент можно установить с помощью HACS. Для этого нажмите голубу кнопку выше или добавьте репозиторий вручную:

1. Перейдите в _HACS__Интеграции_.
1. В правом верхнем углу выберите трехточечное меню, а затем выберите _Пользовательские репозитории_.
Expand All @@ -21,7 +21,7 @@ See description [in English here](./README.md).

## Настройка и использование

Компонент настраивается через `configuration.yaml` :
Компонент настраивается через `configuration.yaml`:

```yaml
notify:
Expand All @@ -30,31 +30,35 @@ notify:
device: /dev/serial/by-id/usb-HUAWEI_Technology_HUAWEI_Mobile-if01-port0 # путь до модема
```
После перезапустите Home Assistant, а затем используйте службу `notify.call` чтобы позвонить. Номер телефона для дозвона указывается в `target`:
После редактирования конфига потребуется перезапустить Home Assistant. Чтобы позвонить, используйте службу `notify.call`. Номер телефона для дозвона указывается в `target`:

```yaml
action:
service: notify.call
data:
target: "+71234567890"
message: "Обязательное поле в HASS, но компонент его не использует"
message: "Обязательное поле в HASS, но компонент его не использует — можете указать любой текст"
```

### Продолжительность дозвона

По умолчанию дозвон происходит в течение примерно 25 секунд. Время дозвона можно указать в `call_duration_sec`:
По умолчанию дозвон длится в течение 30 секунд. Это значение можно поменять через параметр `call_duration_sec`:

```yaml
notify:
- name: call
platform: gsm_call
device: /dev/serial/by-id/usb-HUAWEI_Technology_HUAWEI_Mobile-if01-port0
call_duration_sec: 45
call_duration_sec: 40
```

Если указать слишком большое значение, то оператор может прервать дозвон раньше времени.

Отсчет времени начинается от момента, когда вызываемый телефон начинает звонить.

## Отправка СМС и дополнительный функционал

Интеграция предназначена для совершения звонков. Давайте не будем переусложнять. Не планируется добавлять отправку SMS и другой функционал, не связанный со звонками. Для работы с СМС используйте [эту интеграцию](https://www.home-assistant.io/integrations/sms/).
Интеграция предназначена для совершения звонков. Давайте не будем переусложнять. Не планируется добавлять отправку SMS и другой функционал, который не связан со звонками. Для работы с СМС воспользуйтесь [этой интеграцией](https://www.home-assistant.io/integrations/sms/).

### Использование совместно с интеграцией sms

Expand All @@ -67,7 +71,7 @@ $ ls -1 /dev/serial/by-id/usb-HUAWEI_Technology_HUAWEI_Mobile-if0*
/dev/serial/by-id/usb-HUAWEI_Technology_HUAWEI_Mobile-if02-port0
```

Для использования этой интеграции совместно с [sms](https://www.home-assistant.io/integrations/sms/), укажите разные интерфейсы в настройках каждой интеграции. Иначе они могут блокировать друг друга.
Для использования этой интеграции совместно с [sms](https://www.home-assistant.io/integrations/sms/), укажите разные интерфейсы в настройках каждой интеграции (иначе они могут блокировать друг друга).

## Устранение неполадок

Expand Down

0 comments on commit 442c3d5

Please sign in to comment.