node-red-contrib-yandex-station-management 0.2.5 → 0.3.1

package/README.md

@@ -2,8 +2,10 @@
 С помощью модуля можно через локальное API управлять вопсроизведением на устройсвах Яндекса:
 - Яндекс Станция(протестировано)
 - Яндекс Станция мини(протестировано)
+- Яндекс Станция мини 2 с экраном(протестировано)
 - Яндекс Станци Макс(протестировано)
 - Яндекс Модуль(не протестировано)
+- Яндекс Модуль - 2 (в процессе тестирования)
 - JBL Link Music(не протестировано)
 - JBL Link Portable(протестировано)
 
@@ -13,7 +15,10 @@
 - находятся в одной локальной сети с сервером Node-Red
 
 
-Для работы требуется токен от Яндекс.Музыки. Один из варинатов его получения описан в [FAQ](#faq)
+Для работы требуется токен от Яндекс.Музыки. 
+В модуле в экспериментальном режиме реализована возможность получения токена из логин-пароля(Спасибо слать [сюда](https://github.com/twocolors)). Если получение токена не отрабатывает, то стоит попробовать включить и отключить двух-факторную аутентификацию в настройках Яндекса. [Источник](https://github.com/AlexxIT/YandexStation/issues/103). Убедиться в безопасности использования учетных данных можно, посмотрев [код](./nodes/yandex-login.html)
+
+Второй из варинатов его получения описан в [FAQ](#faq)
 
 Возможна работа с несколькими устройствами(протестировано) и несколькими учетными записями(протестировано).
 
@@ -33,7 +38,9 @@
 ## Первоначальная настройка.
 После установки для начала работы добавить любую ноду, ввести учетные данные(токен) в раздел Login, сохранить и нажать Deploy(обязательно!). Как получить токен - написано в FAQ.
 
-После деплоя в настройках ноды в поле Station должны появиться станции доступные для управления. Если станция не появилась в списке, то можно подождать пару минут или перезапустить Node-Red.
+После деплоя в настройках ноды в поле Station должны появиться станции доступные для управления. 
+
+npmЕсли станция не появилась в списке, то можно подождать пару минут или перезапустить Node-Red.
 
 ## Описание возможностей и сценариев использования.
 ### Нода Station
@@ -106,13 +113,53 @@ Phrase to say - фраза, которую скажет Алиса вместо
 Отправка команды, вместо того, чтобы говорить ее колонке голосом: "Включи свет", "Включи музыку", "Включи мой плейлист", "Отключись через 15 минут" и так далее.
 
 #### TTS.
-Воспросизведение голосом отправленных фраз - Text to Speech. Не имеет ограничения по символам. Есть ряд опций:
-- Fixed volume level. Позволяет произносить фразу заданной громкостью. Если не выбрано, то фраза произносится с текущим уровнем громкости. После произнесения уровень громкости вернется в изначальный.
-- Prevent listening. Если выбрано, то колонка после воспроизведения не "слушает", что ей ответят.
-- Pause while TTS. Ставит воспроизведение плеера на паузу на время речи. Воспроизведение будет продолжено, только если что-то играло на момент поступления команды.
+Воспроизведение голосом отправленных фраз - Text to Speech. Не имеет ограничения по символам. 
+Параметры для TTS могут задаваться как в настройках, так и некоторые из них могут быть переопределены входящим сообщением.
+- Text. Откуда и какой текст проговорить.
+    - из входящего сообщения (msg.payload по-умолчанию)
+    - строго заданную строку
+    - переменную из flow или global context
+    - JSON: выбрать сообщение случайным образом из массива вида ["один", "два", "три"].
+- Voice. Выбор голоса для генерации. Может быть переопределено через  msg.voice
+- Effect. Эффекты для генерации голоса. Может быть переопределено через msg.effect
+- 
+Есть ряд опций:
+- Volume. Позволяет произносить фразу заданной громкостью. Если не выбрано, то фраза произносится с текущим уровнем громкости. После произнесения уровень громкости вернется в изначальный. Может быть переопределено через msg.volume
+- Prevent listening. Если выбрано, то колонка после воспроизведения не "слушает", что ей ответят. Может быть переопределено через msg.prevent_listening
+- Pause while TTS. Ставит воспроизведение плеера на паузу на время речи. Воспроизведение будет продолжено, только если что-то играло на момент поступления команды. Может быть переопределено через msg.pause_music
 Все опции комбинируемы между собой.
 
-Работают голосовые [спецэффекты](https://yandex.ru/dev/dialogs/alice/doc/speech-effects-docpage/),[дополнительные голоса](https://yandex.ru/dev/dialogs/alice/doc/speech-effects-docpage/) и [звуки](https://yandex.ru/dev/dialogs/alice/doc/sounds-docpage/), при этом отправка производится в ввиде строки. Например, "смелость sil <[500]> город+а берёт"
+##### Добавление голосу жизни и красок.
+###### Раставляйте ударения
+При необходимости ударные гласные в словах следует отмечать знаком «+», например:
+
+    остр+ота
+    м+ука
+
+##### Разделяйте слова
+Длинные слова можно разбить на слова покороче и проставить ударения для каждого из этих коротких слов, например:
+
+мн+ого пр+офильный
+с+еми пал+атинск
+
+##### Меняйте написание слов
+Некоторые слова можно попробовать писать так, как они слышатся:
+
+    «ненастный» — нен+асный
+    «пожалуйста» — пож+алуста
+
+###### Добавляйте паузы
+Чтобы задать паузу между словами, используйте синтаксис sil <[ количество_миллисекунд ]>. Например:
+
+    смелость sil <[500]> город+а берёт
+
+Каждый отделенный пробелами пунктуационный знак обозначается паузой в 50-100 мс.
+
+###### Добавляйте [звуки из библиотеки](https://yandex.ru/dev/dialogs/alice/doc/sounds-docpage/)
+
+    <speaker audio=\"alice-sounds-game-win-1.opus\"> У вас получилось!
+
+
 
 
 #### Homekit Formatted.

package/nodes/get.js

@@ -10,36 +10,43 @@ module.exports = function(RED) {
         node.lastState = {};
         node.status({});
 
-    
+
         function debugMessage(text){
             if (node.debugFlag) {
                 node.log(text);
             }
         }
-        function preparePayload(message){
-            let payload = {};
+        function preparePayload(message,inputMsg){
+            //let payload = {};
             if (node.output == 'status') {
-                   payload = {'payload': message}
+                inputMsg.payload = message;
             } else if (node.output == 'homekit') {
                 if (node.homekitFormat == 'speaker') {
-                    (message.playerState)? payload = {'payload': {
+                    let ConfiguredName = `${(message.playerState.subtitle) ? message.playerState.subtitle : 'No Artist'} - ${(message.playerState.title) ? message.playerState.title : 'No Track Name'}`;
+                    let title = `${message.playerState.title}`;
+                    if (ConfiguredName.length > 64 && title.length > 0 && title.length <= 64) {
+                        ConfiguredName = title;
+                    } else {
+                        ConfiguredName = title.substr(0, 61) + `...`;
+                    }
+                    (message.playerState)? inputMsg.payload = {
                         "CurrentMediaState": (message.playing) ? 0 : 1,
-                        "ConfiguredName": `${(message.playerState.subtitle) ? message.playerState.subtitle : 'No Artist'} - ${(message.playerState.title) ? message.playerState.title : 'No Track Name'}`
-                    } }:payload = {'payload': {
+                        "ConfiguredName": ConfiguredName
+                    } :inputMsg.payload =  {
                         "CurrentMediaState": (message.playing) ? 0 : 1,
-                        "ConfiguredName": `No Artist - No Track`
-                    } }
+                        "ConfiguredName": `No Artist - No Track Name`
+                    }
                 }else if (node.homekitFormat == 'tv') {
-                    payload = {'payload': {
+                    inputMsg.payload = {
                         "Active": (message.playing) ? 1 : 0
-                    } 
-                    } 
+                    }
+
                 }
             }
-        return payload;
+        return inputMsg;
 
         }
-        
+
 
         node.onStatus = function(data) {
             if (data) {
@@ -47,9 +54,9 @@ module.exports = function(RED) {
             //node.log('new status ' + data)
             }
          }
-        node.onInput = function(){
-            debugMessage('input message');
-            ( 'aliceState' in node.lastState )?node.send(preparePayload(node.lastState)):node.send({'payload': {}})
+        node.onInput = function(msg, send, done){
+            debugMessage('current state: ' + JSON.stringify(node.lastState));
+            ( 'aliceState' in node.lastState )?node.send(preparePayload(node.lastState,msg)):node.send(msg)
         }
         node.onMessage = function(message){
             node.lastState = message;
@@ -57,7 +64,7 @@ module.exports = function(RED) {
         node.onClose = function(){
             node.controller.removeListener(`message_${node.station}`, node.onMessage)
         }
-        
+
         node.on('input', node.onInput);
 
         node.on('close', node.onClose)

package/nodes/in.js

@@ -10,9 +10,9 @@ module.exports = function(RED) {
         node.homekitFormat = config.homekitFormat;
         node.lastMessage = {};
         node.status({});
-        
 
-       
+
+
         debugMessage(`Node settings: ID: ${node.station}, Output Format: ${node.output}, HK: ${node.homekitFormat}`);
         function debugMessage(text){
             if (node.debugFlag) {
@@ -26,20 +26,32 @@ module.exports = function(RED) {
             if (node.output == 'status') {
                    payload = {'payload': message}
             } else if (node.output == 'homekit') {
-                if (node.homekitFormat == 'speaker') {
-                    (message.playerState)? payload = {'payload': {
-                        "CurrentMediaState": (message.playing) ? 0 : 1,
-                        "ConfiguredName": `${(message.playerState.subtitle) ? message.playerState.subtitle : 'No Artist'} - ${(message.playerState.title) ? message.playerState.title : 'No Track Name'}`
-                    } }:payload = {'payload': {
-                        "CurrentMediaState": (message.playing) ? 0 : 1,
-                        "ConfiguredName": `No Artists - No Track`
-                    } }
-                }else if (node.homekitFormat == 'tv') {
-                    payload = {'payload': {
-                        "Active": (message.playing) ? 1 : 0
-                    } 
-                    } 
+                try {
+                    if (node.homekitFormat == 'speaker') {
+                        let ConfiguredName = `${(message.playerState.subtitle) ? message.playerState.subtitle : 'No Artist'} - ${(message.playerState.title) ? message.playerState.title : 'No Track Name'}`;
+                        let title = `${message.playerState.title}`;
+                        if (ConfiguredName.length > 64 && title.length > 0 && title.length <= 64) {
+                            ConfiguredName = title;
+                        } else {
+                            ConfiguredName = title.substr(0, 61) + `...`;
+                        }
+                        (message.playerState)? payload = {'payload': {
+                            "CurrentMediaState": (message.playing) ? 0 : 1,
+                            "ConfiguredName": ConfiguredName
+                        } }:payload = {'payload': {
+                            "CurrentMediaState": (message.playing) ? 0 : 1,
+                            "ConfiguredName": `No Artists - No Track Name`
+                        } }
+                    }else if (node.homekitFormat == 'tv') {
+                        payload = {'payload': {
+                            "Active": (message.playing) ? 1 : 0
+                        }
+                        }
+                    }
+                } catch(e) {
+                    debugMessage(`Error while preparing payload: `+ e)
                 }
+
             }
         return payload;
 
@@ -50,8 +62,8 @@ module.exports = function(RED) {
                 if ((JSON.stringify(node.lastMessage.payload) != JSON.stringify(message.payload))) {
                     node.send(message)
                     node.lastMessage = message
-                    debugMessage(`Sended message to HK: ${JSON.stringify(message)}`);     
-                
+                    debugMessage(`Sended message to HK: ${JSON.stringify(message)}`);
+
                 }
             } else {
                 node.send(message);
@@ -77,7 +89,7 @@ module.exports = function(RED) {
             node.controller.on(`message_${node.station}`, node.onMessage);
             node.controller.on(`statusUpdate_${node.station}`, node.onStatus);
         }
-       
+
         node.on('close', node.onClose);