OpenHAB
/
openhab-core
mirror of https://github.com/openhab/openhab-core.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[rule] New actions to start/stop dialog processing (#2791) 

* [rule] New actions to start/stop dialog processing

Related to #2688

Signed-off-by: Laurent Garnier <lg.hc@free.fr>
pull/2799/head
lolodomo 2022-02-23 22:15:30 +01:00 committed by GitHub
parent 192e4a2347
commit c0b5f09c2b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 136 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

132
bundles/org.openhab.core.model.script/src/org/openhab/core/model/script/actions/Voice.java
View File

@ -12,15 +12,24 @@
*/
package org.openhab.core.model.script.actions;
import java.util.Locale;
import java.util.Objects;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.core.audio.AudioSink;
import org.openhab.core.audio.AudioSource;
import org.openhab.core.library.types.PercentType;
import org.openhab.core.model.script.engine.action.ActionDoc;
import org.openhab.core.model.script.engine.action.ParamDoc;
import org.openhab.core.model.script.internal.engine.action.VoiceActionService;
import org.openhab.core.voice.KSService;
import org.openhab.core.voice.STTService;
import org.openhab.core.voice.TTSService;
import org.openhab.core.voice.text.HumanLanguageInterpreter;
import org.openhab.core.voice.text.InterpretationException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* The static methods of this class are made available as functions in the scripts.
@ -32,6 +41,8 @@ import org.openhab.core.voice.text.InterpretationException;
@NonNullByDefault
public class Voice {
private static final Logger logger = LoggerFactory.getLogger(Voice.class);
/**
* Says the given text.
*
@ -188,4 +199,125 @@ public class Voice {
return response;
}
/**
* Starts dialog processing for a given audio source using default keyword spotting service, default speech-to-text
* service, default text-to-speech service and default human language text interpreter.
*
* @param source the name of audio source to use or null to use the default source
* @param sink the name of audio sink to use or null to use the default sink
*/
@ActionDoc(text = "starts dialog processing for a given audio source")
public static void startDialog(@ParamDoc(name = "source") @Nullable String source,
@ParamDoc(name = "sink") @Nullable String sink) {
startDialog(null, null, null, null, source, sink, null, null, null);
}
/**
* Starts dialog processing for a given audio source.
*
* @param ks the keyword spotting service to use or null to use the default service
* @param stt the speech-to-text service to use or null to use the default service
* @param tts the text-to-speech service to use or null to use the default service
* @param interpreter the human language text interpreter to use or null to use the default service
* @param source the name of audio source to use or null to use the default source
* @param sink the name of audio sink to use or null to use the default sink
* @param Locale the locale to use or null to use the default locale
* @param keyword the keyword to use during keyword spotting or null to use the default keyword
* @param listeningItem the item to switch ON while listening to a question
*/
@ActionDoc(text = "starts dialog processing for a given audio source")
public static void startDialog(@ParamDoc(name = "keyword spotting service") @Nullable String ks,
@ParamDoc(name = "speech-to-text service") @Nullable String stt,
@ParamDoc(name = "text-to-speech service") @Nullable String tts,
@ParamDoc(name = "interpreter") @Nullable String interpreter,
@ParamDoc(name = "source") @Nullable String source, @ParamDoc(name = "sink") @Nullable String sink,
@ParamDoc(name = "locale") @Nullable String locale, @ParamDoc(name = "keyword") @Nullable String keyword,
@ParamDoc(name = "listening item") @Nullable String listeningItem) {
AudioSource audioSource = null;
if (source != null) {
audioSource = VoiceActionService.audioManager.getSource(source);
if (audioSource == null) {
logger.warn("Failed starting dialog processing: audio source '{}' not found", source);
return;
}
}
KSService ksService = null;
if (ks != null) {
ksService = VoiceActionService.voiceManager.getKS(ks);
if (ksService == null) {
logger.warn("Failed starting dialog processing: keyword spotting service '{}' not found", ks);
return;
}
}
STTService sttService = null;
if (stt != null) {
sttService = VoiceActionService.voiceManager.getSTT(stt);
if (sttService == null) {
logger.warn("Failed starting dialog processing: speech-to-text service '{}' not found", stt);
return;
}
}
TTSService ttsService = null;
if (tts != null) {
ttsService = VoiceActionService.voiceManager.getTTS(tts);
if (ttsService == null) {
logger.warn("Failed starting dialog processing: text-to-speech service '{}' not found", tts);
return;
}
}
HumanLanguageInterpreter hliService = null;
if (interpreter != null) {
hliService = VoiceActionService.voiceManager.getHLI(interpreter);
if (hliService == null) {
logger.warn("Failed starting dialog processing: interpreter '{}' not found", interpreter);
return;
}
}
AudioSink audioSink = null;
if (sink != null) {
audioSink = VoiceActionService.audioManager.getSink(sink);
if (audioSink == null) {
logger.warn("Failed starting dialog processing: audio sink '{}' not found", sink);
return;
}
}
Locale loc = null;
if (locale != null) {
String[] split = locale.split("-");
if (split.length == 2) {
loc = new Locale(split[0], split[1]);
} else {
loc = new Locale(split[0]);
}
}
try {
VoiceActionService.voiceManager.startDialog(ksService, sttService, ttsService, hliService, audioSource,
audioSink, loc, keyword, listeningItem);
} catch (IllegalStateException e) {
logger.warn("Failed starting dialog processing: {}", e.getMessage());
}
}
/**
* Stops dialog processing for a given audio source.
*
* @param source the name of audio source or null to consider the default audio source
*/
@ActionDoc(text = "stops dialog processing for a given audio source")
public static void stopDialog(@ParamDoc(name = "source") @Nullable String source) {
AudioSource audioSource = null;
if (source != null) {
audioSource = VoiceActionService.audioManager.getSource(source);
if (audioSource == null) {
logger.warn("Failed stopping dialog processing: audio source '{}' not found", source);
return;
}
}
try {
VoiceActionService.voiceManager.stopDialog(audioSource);
} catch (IllegalStateException e) {
logger.warn("Failed stopping dialog processing: {}", e.getMessage());
}
}
}

5
bundles/org.openhab.core.model.script/src/org/openhab/core/model/script/internal/engine/action/VoiceActionService.java
View File

@ -14,6 +14,7 @@ package org.openhab.core.model.script.internal.engine.action;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.core.audio.AudioManager;
import org.openhab.core.model.script.actions.Voice;
import org.openhab.core.model.script.engine.action.ActionService;
import org.openhab.core.voice.VoiceManager;
@ -31,10 +32,12 @@ import org.osgi.service.component.annotations.Reference;
public class VoiceActionService implements ActionService {
public static @Nullable VoiceManager voiceManager;
public static @Nullable AudioManager audioManager;
@Activate
public VoiceActionService(final @Reference VoiceManager voiceManager) {
public VoiceActionService(final @Reference VoiceManager voiceManager, final @Reference AudioManager audioManager) {
VoiceActionService.voiceManager = voiceManager;
VoiceActionService.audioManager = audioManager;
}
@Override