Merge pull request #19 from svxa/chime_tts

Add support for ChimeTTS

Author: floris-b

README.md

@@ -75,6 +75,24 @@ Default value to repeat the message
 #### **force_play**: `boolean` | SERVICE QUEUE & SERVICE NOTIFY
 Skip check `device_group` state is `home` 
 
+#### **chimetts_chime_path**: `string` | CONFIG & SERVICE QUEUE & SERVICE NOTIFY
+A preset or custom audio file to be played before TTS audio. [ChimeTTS](https://github.com/nimroddolev/chime_tts) option.
+
+#### **chimetts_end_chime_path**: `string` | CONFIG & SERVICE QUEUE & SERVICE NOTIFY
+A preset or custom audio file to be played after TTS audio. [ChimeTTS](https://github.com/nimroddolev/chime_tts) option.
+
+#### **chimetts_offset**: `float` | CONFIG & SERVICE QUEUE & SERVICE NOTIFY
+Delay between audio segments when value > 0, or overlays audio segments when value < 0. [ChimeTTS](https://github.com/nimroddolev/chime_tts) option.
+
+#### **chimetts_final_delay**: `float` | CONFIG & SERVICE QUEUE & SERVICE NOTIFY
+Delay (in milliseconds) added to the end of the audio. [ChimeTTS](https://github.com/nimroddolev/chime_tts) option.
+
+#### **chimetts_tts_speed**: `float` | CONFIG & SERVICE QUEUE & SERVICE NOTIFY
+Speed of the TTS audio. [ChimeTTS](https://github.com/nimroddolev/chime_tts) option.
+
+#### **chimetts_tts_pitch**: `float` | CONFIG & SERVICE QUEUE & SERVICE NOTIFY
+TTS pitch in semitones. [ChimeTTS](https://github.com/nimroddolev/chime_tts) option.
+
 ### SERVICE QUEUE
 ---
 A service `lms_tts_notify.queue` is also added (besides the notify service for each player) for easy use with the automations gui

custom_components/lms_tts_notify/__init__.py

@@ -25,6 +25,14 @@
 CONF_DEVICE_GROUP = 'device_group'
 CONF_PAUSE = 'pause'
 
+# ChimeTTS options
+CONF_CHIMETTS_OPTION_CHIME_PATH = 'chimetts_chime_path'
+CONF_CHIMETTS_OPTION_END_CHIME_PATH = 'chimetts_end_chime_path'
+CONF_CHIMETTS_OPTION_OFFSET = 'chimetts_offset'
+CONF_CHIMETTS_FINAL_DELAY = 'chimetts_final_delay'
+CONF_CHIMETTS_TTS_SPEED = 'chimetts_tts_speed'
+CONF_CHIMETTS_TTS_PITCH = 'chimetts_tts_pitch'
+
 ATTR_SYNC_GROUP = 'sync_group'
 ATTR_VOLUME = 'volume_level'
 ATTR_POSITION = 'media_position'
@@ -41,6 +49,12 @@
         vol.Optional(CONF_FORCE_PLAY): cv.boolean,
         vol.Optional(CONF_DEVICE_GROUP): cv.entity_id,
         vol.Optional(CONF_PAUSE): cv.positive_float,
+        vol.Optional(CONF_CHIMETTS_OPTION_CHIME_PATH): cv.string,
+        vol.Optional(CONF_CHIMETTS_OPTION_END_CHIME_PATH): cv.string,
+        vol.Optional(CONF_CHIMETTS_OPTION_OFFSET): vol.All(vol.Coerce(int), vol.Range(min=-10000, max=10000)),
+        vol.Optional(CONF_CHIMETTS_FINAL_DELAY): cv.positive_int,
+        vol.Optional(CONF_CHIMETTS_TTS_SPEED): vol.All(vol.Coerce(int), vol.Range(min=1, max=500)),
+        vol.Optional(CONF_CHIMETTS_TTS_PITCH): vol.All(vol.Coerce(int), vol.Range(min=-100, max=100)),
     }
 )
 
@@ -397,14 +411,21 @@ def __init__(self, hass, config):
         self._tts_engine = config.get(ATTR_ENTITY_ID)
         self._config = config
         self._sync_group = []
-        _, self._tts_service = split_entity_id(config[CONF_TTS_SERVICE])
+        self._tts_group, self._tts_service = split_entity_id(config[CONF_TTS_SERVICE])
         _, name = split_entity_id(self._media_player)
         self._name = name + '_queue'
         self.skip_save = False
         self.force_play = False
         self.status = 'idle'
         self._message = ''
         self._device_group = ''
+        self._chimetts_option_chime_path = config.get(CONF_CHIMETTS_OPTION_CHIME_PATH)
+        self._chimetts_option_end_chime_path = config.get(CONF_CHIMETTS_OPTION_END_CHIME_PATH)
+        self._chimetts_option_offset = config.get(CONF_CHIMETTS_OPTION_OFFSET)
+        self._chimetts_final_delay = config.get(CONF_CHIMETTS_FINAL_DELAY)
+        self._chimetts_tts_speed = config.get(CONF_CHIMETTS_TTS_SPEED)
+        self._chimetts_tts_pitch = config.get(CONF_CHIMETTS_TTS_PITCH)
+
 
     def run(self):
         '''Listen to queue events, and play them to mediaplayer'''
@@ -425,6 +446,15 @@ def run(self):
             )
             self.force_play = event.get(CONF_FORCE_PLAY, False)
 
+            self._chimetts_options = {
+                'chime_path': event.get(CONF_CHIMETTS_OPTION_CHIME_PATH, self._chimetts_option_chime_path),
+                'end_chime_path': event.get(CONF_CHIMETTS_OPTION_END_CHIME_PATH, self._chimetts_option_end_chime_path),
+                'offset': event.get(CONF_CHIMETTS_OPTION_OFFSET, self._chimetts_option_offset),
+                'final_delay': event.get(CONF_CHIMETTS_FINAL_DELAY, self._chimetts_final_delay),
+                'tts_speed': event.get(CONF_CHIMETTS_TTS_SPEED, self._chimetts_tts_speed),
+                'tts_pitch': event.get(CONF_CHIMETTS_TTS_PITCH, self._chimetts_tts_pitch),
+            }
+
             home = self._hass.states.get(self._device_group)
             if not home or home.state == 'home' or self.force_play:
                 self.audio_alert()
@@ -523,12 +553,24 @@ def audio_alert(self):
                         'media_player_entity_id': self._media_player,
                         'message': self._message,
                     }
+                elif 'chime_tts' in self._tts_group:
+
+                    _chimetts_options = {k: v for k, v in self._chimetts_options.items() if v is not None}
+                    _LOGGER.debug('ChimeTTS options: %s', _chimetts_options)
+
+                    service_data = {
+                        'tts_platform': self._tts_engine,
+                        'entity_id': self._media_player,
+                        'message': self._message,
+                        **_chimetts_options,
+                    }
                 else:
                     service_data = {
                         ATTR_ENTITY_ID: self._media_player,
                         'message': self._message,
                     }
 
-                self._hass.services.call('tts', self._tts_service, service_data)
+                _LOGGER.debug('Playing message on %s.%s', self._tts_group, self._tts_service)
+                self._hass.services.call(self._tts_group, self._tts_service, service_data)
                 time.sleep(self._pause)
             self.wait_on_idle()

custom_components/lms_tts_notify/manifest.json

@@ -7,5 +7,5 @@
     "issue_tracker": "https://github.com/floris-b/lms_tts_notify/issues",
     "after_dependencies": ["media_player", "squuezebox"],
     "iot_class": "local_push",
-    "version": "0.3.15"
+    "version": "0.3.16"
   }

custom_components/lms_tts_notify/services.yaml

@@ -49,3 +49,200 @@ queue:
       description: Specify which group/enity to track and only play when home
       selector:
         entity:
+
+    chimetts_chime_path:
+      name: "Chime TTS: Chime Path"
+      description: "A preset or custom audio file to be played before TTS audio"
+      example: "custom_components/chime_tts/mp3s/bells.mp3"
+      required: false
+      selector:
+        select:
+          translation_key: "chime_paths"
+          multiple: false
+          custom_value: true
+          mode: dropdown
+          options:
+            - label: "Ba-Dum Tss!"
+              value: "ba_dum_tss"
+            - label: "Bells"
+              value: "bells"
+            - label: "Bells 2"
+              value: "bells_2"
+            - label: "Bright"
+              value: "bright"
+            - label: "Chirp"
+              value: "chirp"
+            - label: "Choir"
+              value: "choir"
+            - label: "Chord"
+              value: "chord"
+            - label: "Classical"
+              value: "classical"
+            - label: "Crickets"
+              value: "crickets"
+            - label: "Ding Dong"
+              value: "ding_dong"
+            - label: "Drum Roll"
+              value: "drumroll"
+            - label: "Dun dun DUUUN!"
+              value: "dun_dun_dun"
+            - label: "Error"
+              value: "error"
+            - label: "Fanfare"
+              value: "fanfare"
+            - label: "Glockenspiel"
+              value: "glockenspiel"
+            - label: "Hail"
+              value: "hail"
+            - label: "Knock"
+              value: "knock"
+            - label: "Marimba"
+              value: "marimba"
+            - label: "Mario Coin"
+              value: "mario_coin"
+            - label: "Microphone Tap"
+              value: "microphone_tap"
+            - label: "Ta-da!"
+              value: "tada"
+            - label: "Toast"
+              value: "toast"
+            - label: "Twenty Four"
+              value: "twenty_four"
+            - label: "Sad Trombone"
+              value: "sad_trombone"
+            - label: "Soft"
+              value: "soft"
+            - label: "Whistle"
+              value: "whistle"
+            - label: "Custom 1"
+              value: "custom_chime_path_1"
+            - label: "Custom 2"
+              value: "custom_chime_path_2"
+            - label: "Custom 3"
+              value: "custom_chime_path_3"
+            - label: "Custom 4"
+              value: "custom_chime_path_4"
+            - label: "Custom 5"
+              value: "custom_chime_path_5"
+    chimetts_end_chime_path:
+      name: "Chime TTS: End Chime Path"
+      description: "A preset or custom audio file to be played after TTS audio"
+      example: "custom_components/chime_tts/mp3s/tada.mp3"
+      required: false
+      selector:
+        select:
+          translation_key: "chime_paths"
+          multiple: false
+          custom_value: true
+          mode: dropdown
+          options:
+            - label: "Ba-Dum Tss!"
+              value: "ba_dum_tss"
+            - label: "Bells"
+              value: "bells"
+            - label: "Bells 2"
+              value: "bells_2"
+            - label: "Bright"
+              value: "bright"
+            - label: "Chirp"
+              value: "chirp"
+            - label: "Choir"
+              value: "choir"
+            - label: "Chord"
+              value: "chord"
+            - label: "Classical"
+              value: "classical"
+            - label: "Crickets"
+              value: "crickets"
+            - label: "Ding Dong"
+              value: "ding_dong"
+            - label: "Drum Roll"
+              value: "drumroll"
+            - label: "Dun dun DUUUN!"
+              value: "dun_dun_dun"
+            - label: "Error"
+              value: "error"
+            - label: "Fanfare"
+              value: "fanfare"
+            - label: "Glockenspiel"
+              value: "glockenspiel"
+            - label: "Hail"
+              value: "hail"
+            - label: "Knock"
+              value: "knock"
+            - label: "Marimba"
+              value: "marimba"
+            - label: "Mario Coin"
+              value: "mario_coin"
+            - label: "Microphone Tap"
+              value: "microphone_tap"
+            - label: "Ta-da!"
+              value: "tada"
+            - label: "Toast"
+              value: "toast"
+            - label: "Twenty Four"
+              value: "twenty_four"
+            - label: "Sad Trombone"
+              value: "sad_trombone"
+            - label: "Soft"
+              value: "soft"
+            - label: "Whistle"
+              value: "whistle"
+            - label: "Custom 1"
+              value: "custom_chime_path_1"
+            - label: "Custom 2"
+              value: "custom_chime_path_2"
+            - label: "Custom 3"
+              value: "custom_chime_path_3"
+            - label: "Custom 4"
+              value: "custom_chime_path_4"
+            - label: "Custom 5"
+              value: "custom_chime_path_5"
+    chimetts_offset:
+      name: "Chime TTS: Offset"
+      description: "Adds a delay between audio segments when value > 0, or overlays audio segments when value < 0."
+      example: 450
+      required: false
+      selector:
+        number:
+          mode: box
+          min: -10000
+          max: 10000
+          step: 10
+          unit_of_measurement: ms
+    chimetts_final_delay:
+      name: "Chime TTS: Final Delay"
+      description: "Final delay (in milliseconds) added to the end of the audio"
+      example: 100
+      required: false
+      selector:
+        number:
+          mode: box
+          min: 0
+          max: 10000
+          step: 1
+          unit_of_measurement: ms
+    chimetts_tts_speed:
+      name: "Chime TTS: TTS Speed"
+      description: "Set the speed of the TTS audio to between 1% and 500% of the original"
+      example: 125
+      required: false
+      selector:
+        number:
+          mode: slider
+          min: 1
+          max: 500
+          step: 5
+          unit_of_measurement: '%'
+    chimetts_tts_pitch:
+      name: "Chime TTS: TTS Pitch"
+      description: "Change the the TTS pitch in semitones. Negative values for lower, positive for higher"
+      example: 3
+      required: false
+      selector:
+        number:
+          mode: slider
+          min: -100
+          max: 100
+          step: 1
+          unit_of_measurement: 'semitones'