2 * Copyright (c) 2010-2020 Contributors to the openHAB project
4 * See the NOTICE file(s) distributed with this work for additional
7 * This program and the accompanying materials are made available under the
8 * terms of the Eclipse Public License 2.0 which is available at
9 * http://www.eclipse.org/legal/epl-2.0
11 * SPDX-License-Identifier: EPL-2.0
13 package org.openhab.binding.amazonechocontrol.internal;
15 import java.io.IOException;
16 import java.io.InputStream;
17 import java.io.InterruptedIOException;
18 import java.io.OutputStream;
19 import java.net.CookieManager;
20 import java.net.CookieStore;
21 import java.net.HttpCookie;
23 import java.net.URISyntaxException;
25 import java.net.URLDecoder;
26 import java.net.URLEncoder;
27 import java.nio.charset.StandardCharsets;
28 import java.text.SimpleDateFormat;
29 import java.util.ArrayList;
30 import java.util.Arrays;
31 import java.util.Base64;
32 import java.util.Collections;
33 import java.util.Date;
34 import java.util.HashMap;
35 import java.util.Iterator;
36 import java.util.LinkedHashMap;
37 import java.util.List;
39 import java.util.Objects;
40 import java.util.Random;
41 import java.util.Scanner;
43 import java.util.concurrent.*;
44 import java.util.concurrent.locks.Lock;
45 import java.util.concurrent.locks.ReentrantLock;
46 import java.util.regex.Matcher;
47 import java.util.regex.Pattern;
48 import java.util.stream.Collectors;
49 import java.util.zip.GZIPInputStream;
51 import javax.net.ssl.HttpsURLConnection;
53 import org.eclipse.jdt.annotation.NonNullByDefault;
54 import org.eclipse.jdt.annotation.Nullable;
55 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonActivities;
56 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonActivities.Activity;
57 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonAnnouncementContent;
58 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonAnnouncementTarget;
59 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonAnnouncementTarget.TargetDevice;
60 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonAscendingAlarm;
61 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonAscendingAlarm.AscendingAlarmModel;
62 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonAutomation;
63 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonAutomation.Payload;
64 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonAutomation.Trigger;
65 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonBluetoothStates;
66 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonBootstrapResult;
67 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonBootstrapResult.Authentication;
68 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonDeviceNotificationState;
69 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonDeviceNotificationState.DeviceNotificationState;
70 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonDevices;
71 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonDevices.Device;
72 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonEnabledFeeds;
73 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonEqualizer;
74 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonExchangeTokenResponse;
75 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonExchangeTokenResponse.Cookie;
76 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonFeed;
77 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonMediaState;
78 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonMusicProvider;
79 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonNetworkDetails;
80 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonNotificationRequest;
81 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonNotificationResponse;
82 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonNotificationSound;
83 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonNotificationSounds;
84 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonNotificationsResponse;
85 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonPlaySearchPhraseOperationPayload;
86 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonPlayValidationResult;
87 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonPlayerState;
88 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonPlaylists;
89 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonRegisterAppRequest;
90 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonRegisterAppResponse;
91 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonRegisterAppResponse.Bearer;
92 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonRegisterAppResponse.DeviceInfo;
93 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonRegisterAppResponse.Extensions;
94 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonRegisterAppResponse.Response;
95 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonRegisterAppResponse.Success;
96 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonRegisterAppResponse.Tokens;
97 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonRenewTokenResponse;
98 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonSmartHomeDevices.SmartHomeDevice;
99 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonSmartHomeGroups.SmartHomeGroup;
100 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonStartRoutineRequest;
101 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonUsersMeResponse;
102 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonWakeWords;
103 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonWakeWords.WakeWord;
104 import org.openhab.binding.amazonechocontrol.internal.jsons.JsonWebSiteCookie;
105 import org.openhab.binding.amazonechocontrol.internal.jsons.SmartHomeBaseDevice;
106 import org.openhab.core.common.ThreadPoolManager;
107 import org.openhab.core.util.HexUtils;
108 import org.slf4j.Logger;
109 import org.slf4j.LoggerFactory;
111 import com.google.gson.*;
114 * The {@link Connection} is responsible for the connection to the amazon server
115 * and handling of the commands
117 * @author Michael Geramb - Initial contribution
120 public class Connection {
121 private static final String THING_THREADPOOL_NAME = "thingHandler";
122 private static final long EXPIRES_IN = 432000; // five days
123 private static final Pattern CHARSET_PATTERN = Pattern.compile("(?i)\\bcharset=\\s*\"?([^\\s;\"]*)");
124 private static final String DEVICE_TYPE = "A2IVLV5VM2W81";
126 private final Logger logger = LoggerFactory.getLogger(Connection.class);
128 protected final ScheduledExecutorService scheduler = ThreadPoolManager.getScheduledPool(THING_THREADPOOL_NAME);
130 private final Random rand = new Random();
131 private final CookieManager cookieManager = new CookieManager();
132 private final Gson gson;
133 private final Gson gsonWithNullSerialization;
135 private String amazonSite = "amazon.com";
136 private String alexaServer = "https://alexa.amazon.com";
137 private final String userAgent;
139 private String serial;
140 private String deviceId;
142 private @Nullable String refreshToken;
143 private @Nullable Date loginTime;
144 private @Nullable Date verifyTime;
145 private long renewTime = 0;
146 private @Nullable String deviceName;
147 private @Nullable String accountCustomerId;
148 private @Nullable String customerName;
150 private Map<Integer, Announcement> announcements = Collections.synchronizedMap(new LinkedHashMap<>());
151 private Map<Integer, TextToSpeech> textToSpeeches = Collections.synchronizedMap(new LinkedHashMap<>());
152 private Map<Integer, Volume> volumes = Collections.synchronizedMap(new LinkedHashMap<>());
153 private Map<String, LinkedBlockingQueue<QueueObject>> devices = Collections.synchronizedMap(new LinkedHashMap<>());
155 private final Map<TimerType, ScheduledFuture<?>> timers = new ConcurrentHashMap<>();
156 private final Map<TimerType, Lock> locks = new ConcurrentHashMap<>();
158 private enum TimerType {
165 public Connection(@Nullable Connection oldConnection, Gson gson) {
168 String serial = null;
169 String deviceId = null;
170 if (oldConnection != null) {
171 deviceId = oldConnection.getDeviceId();
172 frc = oldConnection.getFrc();
173 serial = oldConnection.getSerial();
179 byte[] frcBinary = new byte[313];
180 rand.nextBytes(frcBinary);
181 this.frc = Base64.getEncoder().encodeToString(frcBinary);
183 if (serial != null) {
184 this.serial = serial;
187 byte[] serialBinary = new byte[16];
188 rand.nextBytes(serialBinary);
189 this.serial = HexUtils.bytesToHex(serialBinary);
191 if (deviceId != null) {
192 this.deviceId = deviceId;
194 this.deviceId = generateDeviceId();
198 this.userAgent = "AmazonWebView/Amazon Alexa/2.2.223830.0/iOS/11.4.1/iPhone";
199 GsonBuilder gsonBuilder = new GsonBuilder();
200 gsonWithNullSerialization = gsonBuilder.create();
202 replaceTimer(TimerType.DEVICES,
203 scheduler.scheduleWithFixedDelay(this::handleExecuteSequenceNode, 0, 500, TimeUnit.MILLISECONDS));
207 * Generate a new device id
209 * The device id consists of 16 random bytes in upper-case hex format, a # as separator and a fixed DEVICE_TYPE
211 * @return a string containing the new device-id
213 private String generateDeviceId() {
214 byte[] bytes = new byte[16];
215 rand.nextBytes(bytes);
216 String hexStr = HexUtils.bytesToHex(bytes).toUpperCase() + "#" + DEVICE_TYPE;
217 return HexUtils.bytesToHex(hexStr.getBytes());
221 * Check if deviceId is valid (consisting of hex(hex(16 random bytes)) + "#" + DEVICE_TYPE)
223 * @param deviceId the deviceId
224 * @return true if valid, false if invalid
226 private boolean checkDeviceIdIsValid(@Nullable String deviceId) {
227 if (deviceId != null && deviceId.matches("^[0-9a-fA-F]{92}$")) {
228 String hexString = new String(HexUtils.hexToBytes(deviceId));
229 if (hexString.matches("^[0-9A-F]{32}#" + DEVICE_TYPE + "$")) {
236 private void setAmazonSite(@Nullable String amazonSite) {
237 String correctedAmazonSite = amazonSite != null ? amazonSite : "amazon.com";
238 if (correctedAmazonSite.toLowerCase().startsWith("http://")) {
239 correctedAmazonSite = correctedAmazonSite.substring(7);
241 if (correctedAmazonSite.toLowerCase().startsWith("https://")) {
242 correctedAmazonSite = correctedAmazonSite.substring(8);
244 if (correctedAmazonSite.toLowerCase().startsWith("www.")) {
245 correctedAmazonSite = correctedAmazonSite.substring(4);
247 if (correctedAmazonSite.toLowerCase().startsWith("alexa.")) {
248 correctedAmazonSite = correctedAmazonSite.substring(6);
250 this.amazonSite = correctedAmazonSite;
251 alexaServer = "https://alexa." + this.amazonSite;
254 public @Nullable Date tryGetLoginTime() {
258 public @Nullable Date tryGetVerifyTime() {
262 public String getFrc() {
266 public String getSerial() {
270 public String getDeviceId() {
274 public String getAmazonSite() {
278 public String getAlexaServer() {
282 public String getDeviceName() {
283 String deviceName = this.deviceName;
284 if (deviceName == null) {
290 public String getCustomerId() {
291 String customerId = this.accountCustomerId;
292 if (customerId == null) {
298 public String getCustomerName() {
299 String customerName = this.customerName;
300 if (customerName == null) {
306 public boolean isSequenceNodeQueueRunning() {
307 return devices.values().stream().anyMatch(
308 (queueObjects) -> (queueObjects.stream().anyMatch(queueObject -> queueObject.future != null)));
311 public String serializeLoginData() {
312 Date loginTime = this.loginTime;
313 if (refreshToken == null || loginTime == null) {
316 StringBuilder builder = new StringBuilder();
317 builder.append("7\n"); // version
319 builder.append("\n");
320 builder.append(serial);
321 builder.append("\n");
322 builder.append(deviceId);
323 builder.append("\n");
324 builder.append(refreshToken);
325 builder.append("\n");
326 builder.append(amazonSite);
327 builder.append("\n");
328 builder.append(deviceName);
329 builder.append("\n");
330 builder.append(accountCustomerId);
331 builder.append("\n");
332 builder.append(loginTime.getTime());
333 builder.append("\n");
334 List<HttpCookie> cookies = cookieManager.getCookieStore().getCookies();
335 builder.append(cookies.size());
336 builder.append("\n");
337 for (HttpCookie cookie : cookies) {
338 writeValue(builder, cookie.getName());
339 writeValue(builder, cookie.getValue());
340 writeValue(builder, cookie.getComment());
341 writeValue(builder, cookie.getCommentURL());
342 writeValue(builder, cookie.getDomain());
343 writeValue(builder, cookie.getMaxAge());
344 writeValue(builder, cookie.getPath());
345 writeValue(builder, cookie.getPortlist());
346 writeValue(builder, cookie.getVersion());
347 writeValue(builder, cookie.getSecure());
348 writeValue(builder, cookie.getDiscard());
350 return builder.toString();
353 private void writeValue(StringBuilder builder, @Nullable Object value) {
358 builder.append("\n");
359 builder.append(value.toString());
361 builder.append("\n");
364 private String readValue(Scanner scanner) {
365 if (scanner.nextLine().equals("1")) {
366 String result = scanner.nextLine();
367 if (result != null) {
374 public boolean tryRestoreLogin(@Nullable String data, @Nullable String overloadedDomain) {
375 Date loginTime = tryRestoreSessionData(data, overloadedDomain);
376 if (loginTime != null) {
379 this.loginTime = loginTime;
382 } catch (IOException e) {
384 } catch (URISyntaxException | InterruptedException e) {
390 private @Nullable Date tryRestoreSessionData(@Nullable String data, @Nullable String overloadedDomain) {
392 if (data == null || data.isEmpty()) {
395 Scanner scanner = new Scanner(data);
396 String version = scanner.nextLine();
397 // check if serialize version is supported
398 if (!"5".equals(version) && !"6".equals(version) && !"7".equals(version)) {
402 int intVersion = Integer.parseInt(version);
404 frc = scanner.nextLine();
405 serial = scanner.nextLine();
406 deviceId = scanner.nextLine();
408 // Recreate session and cookies
409 refreshToken = scanner.nextLine();
410 String domain = scanner.nextLine();
411 if (overloadedDomain != null) {
412 domain = overloadedDomain;
414 setAmazonSite(domain);
416 deviceName = scanner.nextLine();
418 if (intVersion > 5) {
419 String accountCustomerId = scanner.nextLine();
420 // Note: version 5 have wrong customer id serialized.
421 // Only use it, if it at least version 6 of serialization
422 if (intVersion > 6) {
423 if (!"null".equals(accountCustomerId)) {
424 this.accountCustomerId = accountCustomerId;
429 Date loginTime = new Date(Long.parseLong(scanner.nextLine()));
430 CookieStore cookieStore = cookieManager.getCookieStore();
431 cookieStore.removeAll();
433 Integer numberOfCookies = Integer.parseInt(scanner.nextLine());
434 for (Integer i = 0; i < numberOfCookies; i++) {
435 String name = readValue(scanner);
436 String value = readValue(scanner);
438 HttpCookie clientCookie = new HttpCookie(name, value);
439 clientCookie.setComment(readValue(scanner));
440 clientCookie.setCommentURL(readValue(scanner));
441 clientCookie.setDomain(readValue(scanner));
442 clientCookie.setMaxAge(Long.parseLong(readValue(scanner)));
443 clientCookie.setPath(readValue(scanner));
444 clientCookie.setPortlist(readValue(scanner));
445 clientCookie.setVersion(Integer.parseInt(readValue(scanner)));
446 clientCookie.setSecure(Boolean.parseBoolean(readValue(scanner)));
447 clientCookie.setDiscard(Boolean.parseBoolean(readValue(scanner)));
449 cookieStore.add(null, clientCookie);
455 String accountCustomerId = this.accountCustomerId;
456 if (accountCustomerId == null || accountCustomerId.isEmpty()) {
457 List<Device> devices = this.getDeviceList();
458 accountCustomerId = devices.stream().filter(device -> serial.equals(device.serialNumber)).findAny()
459 .map(device -> device.deviceOwnerCustomerId).orElse(null);
460 if (accountCustomerId == null || accountCustomerId.isEmpty()) {
461 accountCustomerId = devices.stream().filter(device -> "This Device".equals(device.accountName))
462 .findAny().map(device -> {
463 serial = Objects.requireNonNullElse(device.serialNumber, serial);
464 return device.deviceOwnerCustomerId;
467 this.accountCustomerId = accountCustomerId;
469 } catch (URISyntaxException | IOException | InterruptedException | ConnectionException e) {
470 logger.debug("Getting account customer Id failed", e);
475 private @Nullable Authentication tryGetBootstrap() throws IOException, URISyntaxException, InterruptedException {
476 HttpsURLConnection connection = makeRequest("GET", alexaServer + "/api/bootstrap", null, false, false, null, 0);
477 String contentType = connection.getContentType();
478 if (connection.getResponseCode() == 200 && contentType != null
479 && contentType.toLowerCase().startsWith("application/json")) {
481 String bootstrapResultJson = convertStream(connection);
482 JsonBootstrapResult result = parseJson(bootstrapResultJson, JsonBootstrapResult.class);
483 if (result != null) {
484 Authentication authentication = result.authentication;
485 if (authentication != null && authentication.authenticated) {
486 this.customerName = authentication.customerName;
487 if (this.accountCustomerId == null) {
488 this.accountCustomerId = authentication.customerId;
490 return authentication;
493 } catch (JsonSyntaxException | IllegalStateException e) {
494 logger.info("No valid json received", e);
501 public String convertStream(HttpsURLConnection connection) throws IOException {
502 InputStream input = connection.getInputStream();
507 InputStream readerStream;
508 if ("gzip".equalsIgnoreCase(connection.getContentEncoding())) {
509 readerStream = new GZIPInputStream(connection.getInputStream());
511 readerStream = input;
513 String contentType = connection.getContentType();
514 String charSet = null;
515 if (contentType != null) {
516 Matcher m = CHARSET_PATTERN.matcher(contentType);
518 charSet = m.group(1).trim().toUpperCase();
522 Scanner inputScanner = charSet == null || charSet.isEmpty()
523 ? new Scanner(readerStream, StandardCharsets.UTF_8.name())
524 : new Scanner(readerStream, charSet);
525 Scanner scannerWithoutDelimiter = inputScanner.useDelimiter("\\A");
526 String result = scannerWithoutDelimiter.hasNext() ? scannerWithoutDelimiter.next() : null;
527 inputScanner.close();
528 scannerWithoutDelimiter.close();
530 if (result == null) {
536 public String makeRequestAndReturnString(String url) throws IOException, URISyntaxException, InterruptedException {
537 return makeRequestAndReturnString("GET", url, null, false, null);
540 public String makeRequestAndReturnString(String verb, String url, @Nullable String postData, boolean json,
541 @Nullable Map<String, String> customHeaders) throws IOException, URISyntaxException, InterruptedException {
542 HttpsURLConnection connection = makeRequest(verb, url, postData, json, true, customHeaders, 3);
543 String result = convertStream(connection);
544 logger.debug("Result of {} {}:{}", verb, url, result);
548 public HttpsURLConnection makeRequest(String verb, String url, @Nullable String postData, boolean json,
549 boolean autoredirect, @Nullable Map<String, String> customHeaders, int badRequestRepeats)
550 throws IOException, URISyntaxException, InterruptedException {
551 String currentUrl = url;
552 int redirectCounter = 0;
553 int retryCounter = 0;
554 // loop for handling redirect and bad request, using automatic redirect is not
555 // possible, because all response headers must be catched
558 HttpsURLConnection connection = null;
560 logger.debug("Make request to {}", url);
561 connection = (HttpsURLConnection) new URL(currentUrl).openConnection();
562 connection.setRequestMethod(verb);
563 connection.setRequestProperty("Accept-Language", "en-US");
564 if (customHeaders == null || !customHeaders.containsKey("User-Agent")) {
565 connection.setRequestProperty("User-Agent", userAgent);
567 connection.setRequestProperty("Accept-Encoding", "gzip");
568 connection.setRequestProperty("DNT", "1");
569 connection.setRequestProperty("Upgrade-Insecure-Requests", "1");
570 if (customHeaders != null) {
571 for (String key : customHeaders.keySet()) {
572 String value = customHeaders.get(key);
573 if (value != null && !value.isEmpty()) {
574 connection.setRequestProperty(key, value);
578 connection.setInstanceFollowRedirects(false);
581 URI uri = connection.getURL().toURI();
583 if (customHeaders == null || !customHeaders.containsKey("Cookie")) {
584 StringBuilder cookieHeaderBuilder = new StringBuilder();
585 for (HttpCookie cookie : cookieManager.getCookieStore().get(uri)) {
586 if (cookieHeaderBuilder.length() > 0) {
587 cookieHeaderBuilder.append(";");
589 cookieHeaderBuilder.append(cookie.getName());
590 cookieHeaderBuilder.append("=");
591 cookieHeaderBuilder.append(cookie.getValue());
592 if (cookie.getName().equals("csrf")) {
593 connection.setRequestProperty("csrf", cookie.getValue());
597 if (cookieHeaderBuilder.length() > 0) {
598 String cookies = cookieHeaderBuilder.toString();
599 connection.setRequestProperty("Cookie", cookies);
602 if (postData != null) {
603 logger.debug("{}: {}", verb, postData);
605 byte[] postDataBytes = postData.getBytes(StandardCharsets.UTF_8);
606 int postDataLength = postDataBytes.length;
608 connection.setFixedLengthStreamingMode(postDataLength);
611 connection.setRequestProperty("Content-Type", "application/json; charset=UTF-8");
613 connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
615 connection.setRequestProperty("Content-Length", Integer.toString(postDataLength));
616 if ("POST".equals(verb)) {
617 connection.setRequestProperty("Expect", "100-continue");
620 connection.setDoOutput(true);
621 OutputStream outputStream = connection.getOutputStream();
622 outputStream.write(postDataBytes);
623 outputStream.close();
626 code = connection.getResponseCode();
627 String location = null;
629 // handle response headers
630 Map<@Nullable String, List<String>> headerFields = connection.getHeaderFields();
631 for (Map.Entry<@Nullable String, List<String>> header : headerFields.entrySet()) {
632 String key = header.getKey();
633 if (key != null && !key.isEmpty()) {
634 if (key.equalsIgnoreCase("Set-Cookie")) {
636 for (String cookieHeader : header.getValue()) {
637 if (!cookieHeader.isEmpty()) {
638 List<HttpCookie> cookies = HttpCookie.parse(cookieHeader);
639 for (HttpCookie cookie : cookies) {
640 cookieManager.getCookieStore().add(uri, cookie);
645 if (key.equalsIgnoreCase("Location")) {
646 // get redirect location
647 location = header.getValue().get(0);
648 if (!location.isEmpty()) {
649 location = uri.resolve(location).toString();
651 if (location.toLowerCase().startsWith("http://")) {
653 location = "https://" + location.substring(7);
654 logger.debug("Redirect corrected to {}", location);
661 logger.debug("Call to {} succeeded", url);
663 } else if (code == 302 && location != null) {
664 logger.debug("Redirected to {}", location);
666 if (redirectCounter > 30) {
667 throw new ConnectionException("Too many redirects");
669 currentUrl = location;
671 continue; // repeat with new location
675 logger.debug("Retry call to {}", url);
677 if (retryCounter > badRequestRepeats) {
678 throw new HttpException(code,
679 verb + " url '" + url + "' failed: " + connection.getResponseMessage());
683 } catch (InterruptedException | InterruptedIOException e) {
684 if (connection != null) {
685 connection.disconnect();
687 logger.warn("Unable to wait for next call to {}", url, e);
689 } catch (IOException e) {
690 if (connection != null) {
691 connection.disconnect();
693 logger.warn("Request to url '{}' fails with unknown error", url, e);
695 } catch (Exception e) {
696 if (connection != null) {
697 connection.disconnect();
704 public String registerConnectionAsApp(String oAutRedirectUrl)
705 throws ConnectionException, IOException, URISyntaxException, InterruptedException {
706 URI oAutRedirectUri = new URI(oAutRedirectUrl);
708 Map<String, String> queryParameters = new LinkedHashMap<>();
709 String query = oAutRedirectUri.getQuery();
710 String[] pairs = query.split("&");
711 for (String pair : pairs) {
712 int idx = pair.indexOf("=");
713 queryParameters.put(URLDecoder.decode(pair.substring(0, idx), StandardCharsets.UTF_8.name()),
714 URLDecoder.decode(pair.substring(idx + 1), StandardCharsets.UTF_8.name()));
716 String accessToken = queryParameters.get("openid.oa2.access_token");
718 Map<String, String> cookieMap = new HashMap<>();
720 List<JsonWebSiteCookie> webSiteCookies = new ArrayList<>();
721 for (HttpCookie cookie : getSessionCookies("https://www.amazon.com")) {
722 cookieMap.put(cookie.getName(), cookie.getValue());
723 webSiteCookies.add(new JsonWebSiteCookie(cookie.getName(), cookie.getValue()));
726 JsonWebSiteCookie[] webSiteCookiesArray = new JsonWebSiteCookie[webSiteCookies.size()];
727 webSiteCookiesArray = webSiteCookies.toArray(webSiteCookiesArray);
729 JsonRegisterAppRequest registerAppRequest = new JsonRegisterAppRequest(serial, accessToken, frc,
730 webSiteCookiesArray);
731 String registerAppRequestJson = gson.toJson(registerAppRequest);
733 HashMap<String, String> registerHeaders = new HashMap<>();
734 registerHeaders.put("x-amzn-identity-auth-domain", "api.amazon.com");
736 String registerAppResultJson = makeRequestAndReturnString("POST", "https://api.amazon.com/auth/register",
737 registerAppRequestJson, true, registerHeaders);
738 JsonRegisterAppResponse registerAppResponse = parseJson(registerAppResultJson, JsonRegisterAppResponse.class);
740 if (registerAppResponse == null) {
741 throw new ConnectionException("Error: No response received from register application");
743 Response response = registerAppResponse.response;
744 if (response == null) {
745 throw new ConnectionException("Error: No response received from register application");
747 Success success = response.success;
748 if (success == null) {
749 throw new ConnectionException("Error: No success received from register application");
751 Tokens tokens = success.tokens;
752 if (tokens == null) {
753 throw new ConnectionException("Error: No tokens received from register application");
755 Bearer bearer = tokens.bearer;
756 if (bearer == null) {
757 throw new ConnectionException("Error: No bearer received from register application");
759 String refreshToken = bearer.refreshToken;
760 this.refreshToken = refreshToken;
761 if (refreshToken == null || refreshToken.isEmpty()) {
762 throw new ConnectionException("Error: No refresh token received");
766 // Check which is the owner domain
767 String usersMeResponseJson = makeRequestAndReturnString("GET",
768 "https://alexa.amazon.com/api/users/me?platform=ios&version=2.2.223830.0", null, false, null);
769 JsonUsersMeResponse usersMeResponse = parseJson(usersMeResponseJson, JsonUsersMeResponse.class);
770 if (usersMeResponse == null) {
771 throw new IllegalArgumentException("Received no response on me-request");
773 URI uri = new URI(usersMeResponse.marketPlaceDomainName);
774 String host = uri.getHost();
776 // Switch to owner domain
780 } catch (Exception e) {
784 String deviceName = null;
785 Extensions extensions = success.extensions;
786 if (extensions != null) {
787 DeviceInfo deviceInfo = extensions.deviceInfo;
788 if (deviceInfo != null) {
789 deviceName = deviceInfo.deviceName;
792 if (deviceName == null) {
793 deviceName = "Unknown";
795 this.deviceName = deviceName;
799 private void exchangeToken() throws IOException, URISyntaxException, InterruptedException {
801 String cookiesJson = "{\"cookies\":{\"." + getAmazonSite() + "\":[]}}";
802 String cookiesBase64 = Base64.getEncoder().encodeToString(cookiesJson.getBytes());
804 String exchangePostData = "di.os.name=iOS&app_version=2.2.223830.0&domain=." + getAmazonSite()
805 + "&source_token=" + URLEncoder.encode(this.refreshToken, "UTF8")
806 + "&requested_token_type=auth_cookies&source_token_type=refresh_token&di.hw.version=iPhone&di.sdk.version=6.10.0&cookies="
807 + cookiesBase64 + "&app_name=Amazon%20Alexa&di.os.version=11.4.1";
809 HashMap<String, String> exchangeTokenHeader = new HashMap<>();
810 exchangeTokenHeader.put("Cookie", "");
812 String exchangeTokenJson = makeRequestAndReturnString("POST",
813 "https://www." + getAmazonSite() + "/ap/exchangetoken", exchangePostData, false, exchangeTokenHeader);
814 JsonExchangeTokenResponse exchangeTokenResponse = Objects
815 .requireNonNull(gson.fromJson(exchangeTokenJson, JsonExchangeTokenResponse.class));
817 org.openhab.binding.amazonechocontrol.internal.jsons.JsonExchangeTokenResponse.Response response = exchangeTokenResponse.response;
818 if (response != null) {
819 org.openhab.binding.amazonechocontrol.internal.jsons.JsonExchangeTokenResponse.Tokens tokens = response.tokens;
820 if (tokens != null) {
821 Map<String, Cookie[]> cookiesMap = tokens.cookies;
822 if (cookiesMap != null) {
823 for (String domain : cookiesMap.keySet()) {
824 Cookie[] cookies = cookiesMap.get(domain);
825 if (cookies != null) {
826 for (Cookie cookie : cookies) {
827 if (cookie != null) {
828 HttpCookie httpCookie = new HttpCookie(cookie.name, cookie.value);
829 httpCookie.setPath(cookie.path);
830 httpCookie.setDomain(domain);
831 Boolean secure = cookie.secure;
832 if (secure != null) {
833 httpCookie.setSecure(secure);
835 this.cookieManager.getCookieStore().add(null, httpCookie);
843 if (!verifyLogin()) {
844 throw new ConnectionException("Verify login failed after token exchange");
846 this.renewTime = (long) (System.currentTimeMillis() + Connection.EXPIRES_IN * 1000d / 0.8d); // start renew at
849 public boolean checkRenewSession() throws URISyntaxException, IOException, InterruptedException {
850 if (System.currentTimeMillis() >= this.renewTime) {
851 String renewTokenPostData = "app_name=Amazon%20Alexa&app_version=2.2.223830.0&di.sdk.version=6.10.0&source_token="
852 + URLEncoder.encode(refreshToken, StandardCharsets.UTF_8.name())
853 + "&package_name=com.amazon.echo&di.hw.version=iPhone&platform=iOS&requested_token_type=access_token&source_token_type=refresh_token&di.os.name=iOS&di.os.version=11.4.1¤t_version=6.10.0";
854 String renewTokenResponseJson = makeRequestAndReturnString("POST", "https://api.amazon.com/auth/token",
855 renewTokenPostData, false, null);
856 parseJson(renewTokenResponseJson, JsonRenewTokenResponse.class);
864 public boolean getIsLoggedIn() {
865 return loginTime != null;
868 public String getLoginPage() throws IOException, URISyntaxException, InterruptedException {
869 // clear session data
872 logger.debug("Start Login to {}", alexaServer);
874 if (!checkDeviceIdIsValid(deviceId)) {
875 deviceId = generateDeviceId();
876 logger.debug("Generating new device id (old device id had invalid format).");
879 String mapMdJson = "{\"device_user_dictionary\":[],\"device_registration_data\":{\"software_version\":\"1\"},\"app_identifier\":{\"app_version\":\"2.2.223830\",\"bundle_id\":\"com.amazon.echo\"}}";
880 String mapMdCookie = Base64.getEncoder().encodeToString(mapMdJson.getBytes());
882 cookieManager.getCookieStore().add(new URI("https://www.amazon.com"), new HttpCookie("map-md", mapMdCookie));
883 cookieManager.getCookieStore().add(new URI("https://www.amazon.com"), new HttpCookie("frc", frc));
885 Map<String, String> customHeaders = new HashMap<>();
886 customHeaders.put("authority", "www.amazon.com");
887 String loginFormHtml = makeRequestAndReturnString("GET", "https://www.amazon.com"
888 + "/ap/signin?openid.return_to=https://www.amazon.com/ap/maplanding&openid.assoc_handle=amzn_dp_project_dee_ios&openid.identity=http://specs.openid.net/auth/2.0/identifier_select&pageId=amzn_dp_project_dee_ios&accountStatusPolicy=P1&openid.claimed_id=http://specs.openid.net/auth/2.0/identifier_select&openid.mode=checkid_setup&openid.ns.oa2=http://www.amazon.com/ap/ext/oauth/2&openid.oa2.client_id=device:"
890 + "&openid.ns.pape=http://specs.openid.net/extensions/pape/1.0&openid.oa2.response_type=token&openid.ns=http://specs.openid.net/auth/2.0&openid.pape.max_auth_age=0&openid.oa2.scope=device_auth_access",
891 null, false, customHeaders);
893 logger.debug("Received login form {}", loginFormHtml);
894 return loginFormHtml;
897 public boolean verifyLogin() throws IOException, URISyntaxException, InterruptedException {
898 if (this.refreshToken == null) {
901 Authentication authentication = tryGetBootstrap();
902 if (authentication != null && authentication.authenticated) {
903 verifyTime = new Date();
904 if (loginTime == null) {
905 loginTime = verifyTime;
912 public List<HttpCookie> getSessionCookies() {
914 return cookieManager.getCookieStore().get(new URI(alexaServer));
915 } catch (URISyntaxException e) {
916 return new ArrayList<>();
920 public List<HttpCookie> getSessionCookies(String server) {
922 return cookieManager.getCookieStore().get(new URI(server));
923 } catch (URISyntaxException e) {
924 return new ArrayList<>();
928 private void replaceTimer(TimerType type, @Nullable ScheduledFuture<?> newTimer) {
929 timers.compute(type, (timerType, oldTimer) -> {
930 if (oldTimer != null) {
931 oldTimer.cancel(true);
937 public void logout() {
938 cookieManager.getCookieStore().removeAll();
945 replaceTimer(TimerType.ANNOUNCEMENT, null);
946 announcements.clear();
947 replaceTimer(TimerType.TTS, null);
948 textToSpeeches.clear();
949 replaceTimer(TimerType.VOLUME, null);
951 replaceTimer(TimerType.DEVICES, null);
953 devices.values().forEach((queueObjects) -> {
954 queueObjects.forEach((queueObject) -> {
955 Future<?> future = queueObject.future;
956 if (future != null) {
958 queueObject.future = null;
965 private <T> @Nullable T parseJson(String json, Class<T> type) throws JsonSyntaxException, IllegalStateException {
967 return gson.fromJson(json, type);
968 } catch (JsonParseException | IllegalStateException e) {
969 logger.warn("Parsing json failed: {}", json, e);
974 // commands and states
975 public WakeWord[] getWakeWords() {
978 json = makeRequestAndReturnString(alexaServer + "/api/wake-word?cached=true");
979 JsonWakeWords wakeWords = parseJson(json, JsonWakeWords.class);
980 if (wakeWords != null) {
981 WakeWord[] result = wakeWords.wakeWords;
982 if (result != null) {
986 } catch (IOException | URISyntaxException | InterruptedException e) {
987 logger.info("getting wakewords failed", e);
989 return new WakeWord[0];
992 public List<SmartHomeBaseDevice> getSmarthomeDeviceList()
993 throws IOException, URISyntaxException, InterruptedException {
995 String json = makeRequestAndReturnString(alexaServer + "/api/phoenix");
996 logger.debug("getSmartHomeDevices result: {}", json);
998 JsonNetworkDetails networkDetails = parseJson(json, JsonNetworkDetails.class);
999 if (networkDetails == null) {
1000 throw new IllegalArgumentException("received no response on network detail request");
1002 Object jsonObject = gson.fromJson(networkDetails.networkDetail, Object.class);
1003 List<SmartHomeBaseDevice> result = new ArrayList<>();
1004 searchSmartHomeDevicesRecursive(jsonObject, result);
1007 } catch (Exception e) {
1008 logger.warn("getSmartHomeDevices fails: {}", e.getMessage());
1013 private void searchSmartHomeDevicesRecursive(@Nullable Object jsonNode, List<SmartHomeBaseDevice> devices) {
1014 if (jsonNode instanceof Map) {
1015 @SuppressWarnings("rawtypes")
1016 Map<String, Object> map = (Map) jsonNode;
1017 if (map.containsKey("entityId") && map.containsKey("friendlyName") && map.containsKey("actions")) {
1018 // device node found, create type element and add it to the results
1019 JsonElement element = gson.toJsonTree(jsonNode);
1020 SmartHomeDevice shd = parseJson(element.toString(), SmartHomeDevice.class);
1024 } else if (map.containsKey("applianceGroupName")) {
1025 JsonElement element = gson.toJsonTree(jsonNode);
1026 SmartHomeGroup shg = parseJson(element.toString(), SmartHomeGroup.class);
1031 map.values().forEach(value -> searchSmartHomeDevicesRecursive(value, devices));
1036 public List<Device> getDeviceList() throws IOException, URISyntaxException, InterruptedException {
1037 String json = getDeviceListJson();
1038 JsonDevices devices = parseJson(json, JsonDevices.class);
1039 if (devices != null) {
1040 Device[] result = devices.devices;
1041 if (result != null) {
1042 return new ArrayList<>(Arrays.asList(result));
1045 return Collections.emptyList();
1048 public String getDeviceListJson() throws IOException, URISyntaxException, InterruptedException {
1049 String json = makeRequestAndReturnString(alexaServer + "/api/devices-v2/device?cached=false");
1053 public Map<String, JsonArray> getSmartHomeDeviceStatesJson(Set<String> applianceIds)
1054 throws IOException, URISyntaxException, InterruptedException {
1055 JsonObject requestObject = new JsonObject();
1056 JsonArray stateRequests = new JsonArray();
1057 for (String applianceId : applianceIds) {
1058 JsonObject stateRequest = new JsonObject();
1059 stateRequest.addProperty("entityId", applianceId);
1060 stateRequest.addProperty("entityType", "APPLIANCE");
1061 stateRequests.add(stateRequest);
1063 requestObject.add("stateRequests", stateRequests);
1064 String requestBody = requestObject.toString();
1065 String json = makeRequestAndReturnString("POST", alexaServer + "/api/phoenix/state", requestBody, true, null);
1066 logger.trace("Requested {} and received {}", requestBody, json);
1068 JsonObject responseObject = Objects.requireNonNull(gson.fromJson(json, JsonObject.class));
1069 JsonArray deviceStates = (JsonArray) responseObject.get("deviceStates");
1070 Map<String, JsonArray> result = new HashMap<>();
1071 for (JsonElement deviceState : deviceStates) {
1072 JsonObject deviceStateObject = deviceState.getAsJsonObject();
1073 JsonObject entity = deviceStateObject.get("entity").getAsJsonObject();
1074 String applicanceId = entity.get("entityId").getAsString();
1075 JsonElement capabilityState = deviceStateObject.get("capabilityStates");
1076 if (capabilityState != null && capabilityState.isJsonArray()) {
1077 result.put(applicanceId, capabilityState.getAsJsonArray());
1083 public @Nullable JsonPlayerState getPlayer(Device device)
1084 throws IOException, URISyntaxException, InterruptedException {
1085 String json = makeRequestAndReturnString(alexaServer + "/api/np/player?deviceSerialNumber="
1086 + device.serialNumber + "&deviceType=" + device.deviceType + "&screenWidth=1440");
1087 JsonPlayerState playerState = parseJson(json, JsonPlayerState.class);
1091 public @Nullable JsonMediaState getMediaState(Device device)
1092 throws IOException, URISyntaxException, InterruptedException {
1093 String json = makeRequestAndReturnString(alexaServer + "/api/media/state?deviceSerialNumber="
1094 + device.serialNumber + "&deviceType=" + device.deviceType);
1095 JsonMediaState mediaState = parseJson(json, JsonMediaState.class);
1099 public Activity[] getActivities(int number, @Nullable Long startTime) {
1102 json = makeRequestAndReturnString(alexaServer + "/api/activities?startTime="
1103 + (startTime != null ? startTime : "") + "&size=" + number + "&offset=1");
1104 JsonActivities activities = parseJson(json, JsonActivities.class);
1105 if (activities != null) {
1106 Activity[] activiesArray = activities.activities;
1107 if (activiesArray != null) {
1108 return activiesArray;
1111 } catch (IOException | URISyntaxException | InterruptedException e) {
1112 logger.info("getting activities failed", e);
1114 return new Activity[0];
1117 public @Nullable JsonBluetoothStates getBluetoothConnectionStates() {
1120 json = makeRequestAndReturnString(alexaServer + "/api/bluetooth?cached=true");
1121 } catch (IOException | URISyntaxException | InterruptedException e) {
1122 logger.debug("failed to get bluetooth state: {}", e.getMessage());
1123 return new JsonBluetoothStates();
1125 JsonBluetoothStates bluetoothStates = parseJson(json, JsonBluetoothStates.class);
1126 return bluetoothStates;
1129 public @Nullable JsonPlaylists getPlaylists(Device device)
1130 throws IOException, URISyntaxException, InterruptedException {
1131 String json = makeRequestAndReturnString(
1132 alexaServer + "/api/cloudplayer/playlists?deviceSerialNumber=" + device.serialNumber + "&deviceType="
1133 + device.deviceType + "&mediaOwnerCustomerId=" + getCustomerId(device.deviceOwnerCustomerId));
1134 JsonPlaylists playlists = parseJson(json, JsonPlaylists.class);
1138 public void command(Device device, String command) throws IOException, URISyntaxException, InterruptedException {
1139 String url = alexaServer + "/api/np/command?deviceSerialNumber=" + device.serialNumber + "&deviceType="
1140 + device.deviceType;
1141 makeRequest("POST", url, command, true, true, null, 0);
1144 public void smartHomeCommand(String entityId, String action) throws IOException, InterruptedException {
1145 smartHomeCommand(entityId, action, null, null);
1148 public void smartHomeCommand(String entityId, String action, @Nullable String property, @Nullable Object value)
1149 throws IOException, InterruptedException {
1150 String url = alexaServer + "/api/phoenix/state";
1152 JsonObject json = new JsonObject();
1153 JsonArray controlRequests = new JsonArray();
1154 JsonObject controlRequest = new JsonObject();
1155 controlRequest.addProperty("entityId", entityId);
1156 controlRequest.addProperty("entityType", "APPLIANCE");
1157 JsonObject parameters = new JsonObject();
1158 parameters.addProperty("action", action);
1159 if (property != null) {
1160 if (value instanceof Boolean) {
1161 parameters.addProperty(property, (boolean) value);
1162 } else if (value instanceof String) {
1163 parameters.addProperty(property, (String) value);
1164 } else if (value instanceof Number) {
1165 parameters.addProperty(property, (Number) value);
1166 } else if (value instanceof Character) {
1167 parameters.addProperty(property, (Character) value);
1168 } else if (value instanceof JsonElement) {
1169 parameters.add(property, (JsonElement) value);
1172 controlRequest.add("parameters", parameters);
1173 controlRequests.add(controlRequest);
1174 json.add("controlRequests", controlRequests);
1176 String requestBody = json.toString();
1178 String resultBody = makeRequestAndReturnString("PUT", url, requestBody, true, null);
1179 logger.debug("{}", resultBody);
1180 JsonObject result = parseJson(resultBody, JsonObject.class);
1181 if (result != null) {
1182 JsonElement errors = result.get("errors");
1183 if (errors != null && errors.isJsonArray()) {
1184 JsonArray errorList = errors.getAsJsonArray();
1185 if (errorList.size() > 0) {
1186 logger.info("Smart home device command failed.");
1187 logger.info("Request:");
1188 logger.info("{}", requestBody);
1189 logger.info("Answer:");
1190 for (JsonElement error : errorList) {
1191 logger.info("{}", error.toString());
1196 } catch (URISyntaxException e) {
1197 logger.info("Wrong url {}", url, e);
1201 public void notificationVolume(Device device, int volume)
1202 throws IOException, URISyntaxException, InterruptedException {
1203 String url = alexaServer + "/api/device-notification-state/" + device.deviceType + "/" + device.softwareVersion
1204 + "/" + device.serialNumber;
1205 String command = "{\"deviceSerialNumber\":\"" + device.serialNumber + "\",\"deviceType\":\"" + device.deviceType
1206 + "\",\"softwareVersion\":\"" + device.softwareVersion + "\",\"volumeLevel\":" + volume + "}";
1207 makeRequest("PUT", url, command, true, true, null, 0);
1210 public void ascendingAlarm(Device device, boolean ascendingAlarm)
1211 throws IOException, URISyntaxException, InterruptedException {
1212 String url = alexaServer + "/api/ascending-alarm/" + device.serialNumber;
1213 String command = "{\"ascendingAlarmEnabled\":" + (ascendingAlarm ? "true" : "false")
1214 + ",\"deviceSerialNumber\":\"" + device.serialNumber + "\",\"deviceType\":\"" + device.deviceType
1215 + "\",\"deviceAccountId\":null}";
1216 makeRequest("PUT", url, command, true, true, null, 0);
1219 public DeviceNotificationState[] getDeviceNotificationStates() {
1222 json = makeRequestAndReturnString(alexaServer + "/api/device-notification-state");
1223 JsonDeviceNotificationState result = parseJson(json, JsonDeviceNotificationState.class);
1224 if (result != null) {
1225 DeviceNotificationState[] deviceNotificationStates = result.deviceNotificationStates;
1226 if (deviceNotificationStates != null) {
1227 return deviceNotificationStates;
1230 } catch (IOException | URISyntaxException | InterruptedException e) {
1231 logger.info("Error getting device notification states", e);
1233 return new DeviceNotificationState[0];
1236 public AscendingAlarmModel[] getAscendingAlarm() {
1239 json = makeRequestAndReturnString(alexaServer + "/api/ascending-alarm");
1240 JsonAscendingAlarm result = parseJson(json, JsonAscendingAlarm.class);
1241 if (result != null) {
1242 AscendingAlarmModel[] ascendingAlarmModelList = result.ascendingAlarmModelList;
1243 if (ascendingAlarmModelList != null) {
1244 return ascendingAlarmModelList;
1247 } catch (IOException | URISyntaxException | InterruptedException e) {
1248 logger.info("Error getting device notification states", e);
1250 return new AscendingAlarmModel[0];
1253 public void bluetooth(Device device, @Nullable String address)
1254 throws IOException, URISyntaxException, InterruptedException {
1255 if (address == null || address.isEmpty()) {
1258 alexaServer + "/api/bluetooth/disconnect-sink/" + device.deviceType + "/" + device.serialNumber, "",
1259 true, true, null, 0);
1262 alexaServer + "/api/bluetooth/pair-sink/" + device.deviceType + "/" + device.serialNumber,
1263 "{\"bluetoothDeviceAddress\":\"" + address + "\"}", true, true, null, 0);
1267 private @Nullable String getCustomerId(@Nullable String defaultId) {
1268 String accountCustomerId = this.accountCustomerId;
1269 return accountCustomerId == null || accountCustomerId.isEmpty() ? defaultId : accountCustomerId;
1272 public void playRadio(Device device, @Nullable String stationId)
1273 throws IOException, URISyntaxException, InterruptedException {
1274 if (stationId == null || stationId.isEmpty()) {
1275 command(device, "{\"type\":\"PauseCommand\"}");
1278 alexaServer + "/api/tunein/queue-and-play?deviceSerialNumber=" + device.serialNumber
1279 + "&deviceType=" + device.deviceType + "&guideId=" + stationId
1280 + "&contentType=station&callSign=&mediaOwnerCustomerId="
1281 + getCustomerId(device.deviceOwnerCustomerId),
1282 "", true, true, null, 0);
1286 public void playAmazonMusicTrack(Device device, @Nullable String trackId)
1287 throws IOException, URISyntaxException, InterruptedException {
1288 if (trackId == null || trackId.isEmpty()) {
1289 command(device, "{\"type\":\"PauseCommand\"}");
1291 String command = "{\"trackId\":\"" + trackId + "\",\"playQueuePrime\":true}";
1293 alexaServer + "/api/cloudplayer/queue-and-play?deviceSerialNumber=" + device.serialNumber
1294 + "&deviceType=" + device.deviceType + "&mediaOwnerCustomerId="
1295 + getCustomerId(device.deviceOwnerCustomerId) + "&shuffle=false",
1296 command, true, true, null, 0);
1300 public void playAmazonMusicPlayList(Device device, @Nullable String playListId)
1301 throws IOException, URISyntaxException, InterruptedException {
1302 if (playListId == null || playListId.isEmpty()) {
1303 command(device, "{\"type\":\"PauseCommand\"}");
1305 String command = "{\"playlistId\":\"" + playListId + "\",\"playQueuePrime\":true}";
1307 alexaServer + "/api/cloudplayer/queue-and-play?deviceSerialNumber=" + device.serialNumber
1308 + "&deviceType=" + device.deviceType + "&mediaOwnerCustomerId="
1309 + getCustomerId(device.deviceOwnerCustomerId) + "&shuffle=false",
1310 command, true, true, null, 0);
1314 public void announcement(Device device, String speak, String bodyText, @Nullable String title,
1315 @Nullable Integer ttsVolume, @Nullable Integer standardVolume) {
1316 if (speak.replaceAll("<.+?>", " ").replaceAll("\\s+", " ").trim().isEmpty()) {
1320 // we lock announcements until we have finished adding this one
1321 Lock lock = locks.computeIfAbsent(TimerType.ANNOUNCEMENT, k -> new ReentrantLock());
1324 Announcement announcement = Objects.requireNonNull(announcements.computeIfAbsent(
1325 Objects.hash(speak, bodyText, title), k -> new Announcement(speak, bodyText, title)));
1326 announcement.devices.add(device);
1327 announcement.ttsVolumes.add(ttsVolume);
1328 announcement.standardVolumes.add(standardVolume);
1330 // schedule an announcement only if it has not been scheduled before
1331 timers.computeIfAbsent(TimerType.ANNOUNCEMENT,
1332 k -> scheduler.schedule(this::sendAnnouncement, 500, TimeUnit.MILLISECONDS));
1338 private void sendAnnouncement() {
1339 // we lock new announcements until we have dispatched everything
1340 Lock lock = locks.computeIfAbsent(TimerType.ANNOUNCEMENT, k -> new ReentrantLock());
1343 Iterator<Announcement> iterator = announcements.values().iterator();
1344 while (iterator.hasNext()) {
1345 Announcement announcement = iterator.next();
1347 List<Device> devices = announcement.devices;
1348 if (!devices.isEmpty()) {
1349 String speak = announcement.speak;
1350 String bodyText = announcement.bodyText;
1351 String title = announcement.title;
1353 Map<String, Object> parameters = new HashMap<>();
1354 parameters.put("expireAfter", "PT5S");
1355 JsonAnnouncementContent[] contentArray = new JsonAnnouncementContent[1];
1356 JsonAnnouncementContent content = new JsonAnnouncementContent();
1357 content.display.title = title == null || title.isEmpty() ? "openHAB" : title;
1358 content.display.body = bodyText.replaceAll("<.+?>", " ").replaceAll("\\s+", " ").trim();
1359 if (speak.startsWith("<speak>") && speak.endsWith("</speak>")) {
1360 content.speak.type = "ssml";
1362 content.speak.value = speak;
1364 contentArray[0] = content;
1366 parameters.put("content", contentArray);
1368 JsonAnnouncementTarget target = new JsonAnnouncementTarget();
1369 target.customerId = devices.get(0).deviceOwnerCustomerId;
1370 TargetDevice[] targetDevices = devices.stream().map(TargetDevice::new)
1371 .collect(Collectors.toList()).toArray(new TargetDevice[0]);
1372 target.devices = targetDevices;
1373 parameters.put("target", target);
1375 String customerId = getCustomerId(devices.get(0).deviceOwnerCustomerId);
1376 if (customerId != null) {
1377 parameters.put("customerId", customerId);
1379 executeSequenceCommandWithVolume(devices, "AlexaAnnouncement", parameters,
1380 announcement.ttsVolumes, announcement.standardVolumes);
1382 } catch (Exception e) {
1383 logger.warn("send announcement fails with unexpected error", e);
1388 // the timer is done anyway immediately after we unlock
1389 timers.remove(TimerType.ANNOUNCEMENT);
1394 public void textToSpeech(Device device, String text, @Nullable Integer ttsVolume,
1395 @Nullable Integer standardVolume) {
1396 if (text.replaceAll("<.+?>", "").replaceAll("\\s+", " ").trim().isEmpty()) {
1400 // we lock TTS until we have finished adding this one
1401 Lock lock = locks.computeIfAbsent(TimerType.TTS, k -> new ReentrantLock());
1404 TextToSpeech textToSpeech = Objects
1405 .requireNonNull(textToSpeeches.computeIfAbsent(Objects.hash(text), k -> new TextToSpeech(text)));
1406 textToSpeech.devices.add(device);
1407 textToSpeech.ttsVolumes.add(ttsVolume);
1408 textToSpeech.standardVolumes.add(standardVolume);
1409 // schedule a TTS only if it has not been scheduled before
1410 timers.computeIfAbsent(TimerType.TTS,
1411 k -> scheduler.schedule(this::sendTextToSpeech, 500, TimeUnit.MILLISECONDS));
1417 private void sendTextToSpeech() {
1418 // we lock new TTS until we have dispatched everything
1419 Lock lock = locks.computeIfAbsent(TimerType.TTS, k -> new ReentrantLock());
1422 Iterator<TextToSpeech> iterator = textToSpeeches.values().iterator();
1423 while (iterator.hasNext()) {
1424 TextToSpeech textToSpeech = iterator.next();
1426 List<Device> devices = textToSpeech.devices;
1427 if (!devices.isEmpty()) {
1428 String text = textToSpeech.text;
1429 Map<String, Object> parameters = new HashMap<>();
1430 parameters.put("textToSpeak", text);
1431 executeSequenceCommandWithVolume(devices, "Alexa.Speak", parameters, textToSpeech.ttsVolumes,
1432 textToSpeech.standardVolumes);
1434 } catch (Exception e) {
1435 logger.warn("send textToSpeech fails with unexpected error", e);
1440 // the timer is done anyway immediately after we unlock
1441 timers.remove(TimerType.TTS);
1446 public void volume(Device device, int vol) {
1447 // we lock volume until we have finished adding this one
1448 Lock lock = locks.computeIfAbsent(TimerType.VOLUME, k -> new ReentrantLock());
1451 Volume volume = Objects.requireNonNull(volumes.computeIfAbsent(vol, k -> new Volume(vol)));
1452 volume.devices.add(device);
1453 volume.volumes.add(vol);
1454 // schedule a TTS only if it has not been scheduled before
1455 timers.computeIfAbsent(TimerType.VOLUME,
1456 k -> scheduler.schedule(this::sendVolume, 500, TimeUnit.MILLISECONDS));
1462 private void sendVolume() {
1463 // we lock new volume until we have dispatched everything
1464 Lock lock = locks.computeIfAbsent(TimerType.VOLUME, k -> new ReentrantLock());
1467 Iterator<Volume> iterator = volumes.values().iterator();
1468 while (iterator.hasNext()) {
1469 Volume volume = iterator.next();
1471 List<Device> devices = volume.devices;
1472 if (!devices.isEmpty()) {
1473 executeSequenceCommandWithVolume(devices, null, Map.of(), volume.volumes, List.of());
1475 } catch (Exception e) {
1476 logger.warn("send volume fails with unexpected error", e);
1481 // the timer is done anyway immediately after we unlock
1482 timers.remove(TimerType.VOLUME);
1487 private void executeSequenceCommandWithVolume(List<Device> devices, @Nullable String command,
1488 Map<String, Object> parameters, List<@Nullable Integer> ttsVolumes,
1489 List<@Nullable Integer> standardVolumes) {
1490 JsonArray serialNodesToExecute = new JsonArray();
1491 JsonArray ttsVolumeNodesToExecute = new JsonArray();
1492 for (int i = 0; i < devices.size(); i++) {
1493 Integer ttsVolume = ttsVolumes.size() > i ? ttsVolumes.get(i) : null;
1494 Integer standardVolume = standardVolumes.size() > i ? standardVolumes.get(i) : null;
1495 if (ttsVolume != null && (standardVolume != null || !ttsVolume.equals(standardVolume))) {
1496 ttsVolumeNodesToExecute.add(
1497 createExecutionNode(devices.get(i), "Alexa.DeviceControls.Volume", Map.of("value", ttsVolume)));
1500 if (ttsVolumeNodesToExecute.size() > 0) {
1501 JsonObject parallelNodesToExecute = new JsonObject();
1502 parallelNodesToExecute.addProperty("@type", "com.amazon.alexa.behaviors.model.ParallelNode");
1503 parallelNodesToExecute.add("nodesToExecute", ttsVolumeNodesToExecute);
1504 serialNodesToExecute.add(parallelNodesToExecute);
1507 if (command != null && !parameters.isEmpty()) {
1508 JsonArray commandNodesToExecute = new JsonArray();
1509 if ("Alexa.Speak".equals(command)) {
1510 for (Device device : devices) {
1511 commandNodesToExecute.add(createExecutionNode(device, command, parameters));
1514 commandNodesToExecute.add(createExecutionNode(devices.get(0), command, parameters));
1516 if (commandNodesToExecute.size() > 0) {
1517 JsonObject parallelNodesToExecute = new JsonObject();
1518 parallelNodesToExecute.addProperty("@type", "com.amazon.alexa.behaviors.model.ParallelNode");
1519 parallelNodesToExecute.add("nodesToExecute", commandNodesToExecute);
1520 serialNodesToExecute.add(parallelNodesToExecute);
1524 JsonArray standardVolumeNodesToExecute = new JsonArray();
1525 for (int i = 0; i < devices.size(); i++) {
1526 Integer ttsVolume = ttsVolumes.size() > i ? ttsVolumes.get(i) : null;
1527 Integer standardVolume = standardVolumes.size() > i ? standardVolumes.get(i) : null;
1528 if (ttsVolume != null && standardVolume != null && !ttsVolume.equals(standardVolume)) {
1529 standardVolumeNodesToExecute.add(createExecutionNode(devices.get(i), "Alexa.DeviceControls.Volume",
1530 Map.of("value", standardVolume)));
1533 if (standardVolumeNodesToExecute.size() > 0) {
1534 JsonObject parallelNodesToExecute = new JsonObject();
1535 parallelNodesToExecute.addProperty("@type", "com.amazon.alexa.behaviors.model.ParallelNode");
1536 parallelNodesToExecute.add("nodesToExecute", standardVolumeNodesToExecute);
1537 serialNodesToExecute.add(parallelNodesToExecute);
1540 if (serialNodesToExecute.size() > 0) {
1541 executeSequenceNodes(devices, serialNodesToExecute, false);
1545 // commands: Alexa.Weather.Play, Alexa.Traffic.Play, Alexa.FlashBriefing.Play,
1546 // Alexa.GoodMorning.Play,
1547 // Alexa.SingASong.Play, Alexa.TellStory.Play, Alexa.Speak (textToSpeach)
1548 public void executeSequenceCommand(Device device, String command, Map<String, Object> parameters) {
1549 JsonObject nodeToExecute = createExecutionNode(device, command, parameters);
1550 executeSequenceNode(List.of(device), nodeToExecute);
1553 private void executeSequenceNode(List<Device> devices, JsonObject nodeToExecute) {
1554 QueueObject queueObject = new QueueObject();
1555 queueObject.devices = devices;
1556 queueObject.nodeToExecute = nodeToExecute;
1557 String serialNumbers = "";
1558 for (Device device : devices) {
1559 String serialNumber = device.serialNumber;
1560 if (serialNumber != null) {
1561 Objects.requireNonNull(this.devices.computeIfAbsent(serialNumber, k -> new LinkedBlockingQueue<>()))
1562 .offer(queueObject);
1563 serialNumbers = serialNumbers + device.serialNumber + " ";
1566 logger.debug("added {} device {}", queueObject.hashCode(), serialNumbers);
1569 private void handleExecuteSequenceNode() {
1570 Lock lock = locks.computeIfAbsent(TimerType.DEVICES, k -> new ReentrantLock());
1571 if (lock.tryLock()) {
1573 for (String serialNumber : devices.keySet()) {
1574 LinkedBlockingQueue<QueueObject> queueObjects = devices.get(serialNumber);
1575 if (queueObjects != null) {
1576 QueueObject queueObject = queueObjects.peek();
1577 if (queueObject != null) {
1578 Future<?> future = queueObject.future;
1579 if (future == null || future.isDone()) {
1580 boolean execute = true;
1582 for (Device tmpDevice : queueObject.devices) {
1583 if (!serialNumber.equals(tmpDevice.serialNumber)) {
1584 LinkedBlockingQueue<QueueObject> tmpQueueObjects = devices
1585 .get(tmpDevice.serialNumber);
1586 if (tmpQueueObjects != null) {
1587 QueueObject tmpQueueObject = tmpQueueObjects.peek();
1588 Future<?> tmpFuture = tmpQueueObject.future;
1589 if (!queueObject.equals(tmpQueueObject)
1590 || (tmpFuture != null && !tmpFuture.isDone())) {
1594 serial = serial + tmpDevice.serialNumber + " ";
1599 queueObject.future = scheduler.submit(() -> queuedExecuteSequenceNode(queueObject));
1600 logger.debug("thread {} device {}", queueObject.hashCode(), serial);
1612 private void queuedExecuteSequenceNode(QueueObject queueObject) {
1613 JsonObject nodeToExecute = queueObject.nodeToExecute;
1614 ExecutionNodeObject executionNodeObject = getExecutionNodeObject(nodeToExecute);
1615 if (executionNodeObject == null) {
1616 logger.debug("executionNodeObject empty, removing without execution");
1617 removeObjectFromQueueAfterExecutionCompletion(queueObject);
1620 List<String> types = executionNodeObject.types;
1622 if (types.contains("Alexa.DeviceControls.Volume")) {
1625 if (types.contains("Announcement")) {
1631 JsonObject sequenceJson = new JsonObject();
1632 sequenceJson.addProperty("@type", "com.amazon.alexa.behaviors.model.Sequence");
1633 sequenceJson.add("startNode", nodeToExecute);
1635 JsonStartRoutineRequest request = new JsonStartRoutineRequest();
1636 request.sequenceJson = gson.toJson(sequenceJson);
1637 String json = gson.toJson(request);
1639 Map<String, String> headers = new HashMap<>();
1640 headers.put("Routines-Version", "1.1.218665");
1642 String text = executionNodeObject.text;
1644 text = text.replaceAll("<.+?>", " ").replaceAll("\\s+", " ").trim();
1645 delay += text.length() * 150;
1648 makeRequest("POST", alexaServer + "/api/behaviors/preview", json, true, true, null, 3);
1650 Thread.sleep(delay);
1651 } catch (IOException | URISyntaxException | InterruptedException e) {
1652 logger.warn("execute sequence node fails with unexpected error", e);
1654 removeObjectFromQueueAfterExecutionCompletion(queueObject);
1658 private void removeObjectFromQueueAfterExecutionCompletion(QueueObject queueObject) {
1660 for (Device device : queueObject.devices) {
1661 String serialNumber = device.serialNumber;
1662 if (serialNumber != null) {
1663 LinkedBlockingQueue<?> queue = devices.get(serialNumber);
1664 if (queue != null) {
1665 queue.remove(queueObject);
1667 serial = serial + serialNumber + " ";
1670 logger.debug("removed {} device {}", queueObject.hashCode(), serial);
1673 private void executeSequenceNodes(List<Device> devices, JsonArray nodesToExecute, boolean parallel) {
1674 JsonObject serialNode = new JsonObject();
1676 serialNode.addProperty("@type", "com.amazon.alexa.behaviors.model.ParallelNode");
1678 serialNode.addProperty("@type", "com.amazon.alexa.behaviors.model.SerialNode");
1681 serialNode.add("nodesToExecute", nodesToExecute);
1683 executeSequenceNode(devices, serialNode);
1686 private JsonObject createExecutionNode(@Nullable Device device, String command, Map<String, Object> parameters) {
1687 JsonObject operationPayload = new JsonObject();
1688 if (device != null) {
1689 operationPayload.addProperty("deviceType", device.deviceType);
1690 operationPayload.addProperty("deviceSerialNumber", device.serialNumber);
1691 operationPayload.addProperty("locale", "");
1692 operationPayload.addProperty("customerId", getCustomerId(device.deviceOwnerCustomerId));
1694 for (String key : parameters.keySet()) {
1695 Object value = parameters.get(key);
1696 if (value instanceof String) {
1697 operationPayload.addProperty(key, (String) value);
1698 } else if (value instanceof Number) {
1699 operationPayload.addProperty(key, (Number) value);
1700 } else if (value instanceof Boolean) {
1701 operationPayload.addProperty(key, (Boolean) value);
1702 } else if (value instanceof Character) {
1703 operationPayload.addProperty(key, (Character) value);
1705 operationPayload.add(key, gson.toJsonTree(value));
1709 JsonObject nodeToExecute = new JsonObject();
1710 nodeToExecute.addProperty("@type", "com.amazon.alexa.behaviors.model.OpaquePayloadOperationNode");
1711 nodeToExecute.addProperty("type", command);
1712 nodeToExecute.add("operationPayload", operationPayload);
1713 return nodeToExecute;
1717 private ExecutionNodeObject getExecutionNodeObject(JsonObject nodeToExecute) {
1718 ExecutionNodeObject executionNodeObject = new ExecutionNodeObject();
1719 if (nodeToExecute.has("nodesToExecute")) {
1720 JsonArray serialNodesToExecute = nodeToExecute.getAsJsonArray("nodesToExecute");
1721 if (serialNodesToExecute != null && serialNodesToExecute.size() > 0) {
1722 for (int i = 0; i < serialNodesToExecute.size(); i++) {
1723 JsonObject serialNodesToExecuteJsonObject = serialNodesToExecute.get(i).getAsJsonObject();
1724 if (serialNodesToExecuteJsonObject.has("nodesToExecute")) {
1725 JsonArray parallelNodesToExecute = serialNodesToExecuteJsonObject
1726 .getAsJsonArray("nodesToExecute");
1727 if (parallelNodesToExecute != null && parallelNodesToExecute.size() > 0) {
1728 JsonObject parallelNodesToExecuteJsonObject = parallelNodesToExecute.get(0)
1730 if (processNodesToExecuteJsonObject(executionNodeObject,
1731 parallelNodesToExecuteJsonObject)) {
1736 if (processNodesToExecuteJsonObject(executionNodeObject, serialNodesToExecuteJsonObject)) {
1744 return executionNodeObject;
1747 private boolean processNodesToExecuteJsonObject(ExecutionNodeObject executionNodeObject,
1748 JsonObject nodesToExecuteJsonObject) {
1749 if (nodesToExecuteJsonObject.has("type")) {
1750 executionNodeObject.types.add(nodesToExecuteJsonObject.get("type").getAsString());
1751 if (nodesToExecuteJsonObject.has("operationPayload")) {
1752 JsonObject operationPayload = nodesToExecuteJsonObject.getAsJsonObject("operationPayload");
1753 if (operationPayload != null) {
1754 if (operationPayload.has("textToSpeak")) {
1755 executionNodeObject.text = operationPayload.get("textToSpeak").getAsString();
1757 } else if (operationPayload.has("content")) {
1758 JsonArray content = operationPayload.getAsJsonArray("content");
1759 if (content != null && content.size() > 0) {
1760 JsonObject contentJsonObject = content.get(0).getAsJsonObject();
1761 if (contentJsonObject.has("speak")) {
1762 JsonObject speak = contentJsonObject.getAsJsonObject("speak");
1763 if (speak != null && speak.has("value")) {
1764 executionNodeObject.text = speak.get("value").getAsString();
1776 public void startRoutine(Device device, String utterance)
1777 throws IOException, URISyntaxException, InterruptedException {
1778 JsonAutomation found = null;
1779 String deviceLocale = "";
1780 JsonAutomation[] routines = getRoutines();
1781 if (routines == null) {
1784 for (JsonAutomation routine : routines) {
1785 if (routine != null) {
1786 Trigger[] triggers = routine.triggers;
1787 if (triggers != null && routine.sequence != null) {
1788 for (JsonAutomation.Trigger trigger : triggers) {
1789 if (trigger == null) {
1792 Payload payload = trigger.payload;
1793 if (payload == null) {
1796 String payloadUtterance = payload.utterance;
1797 if (payloadUtterance != null && payloadUtterance.equalsIgnoreCase(utterance)) {
1799 deviceLocale = payload.locale;
1806 if (found != null) {
1807 String sequenceJson = gson.toJson(found.sequence);
1809 JsonStartRoutineRequest request = new JsonStartRoutineRequest();
1810 request.behaviorId = found.automationId;
1813 // "deviceType":"ALEXA_CURRENT_DEVICE_TYPE"
1814 String deviceType = "\"deviceType\":\"ALEXA_CURRENT_DEVICE_TYPE\"";
1815 String newDeviceType = "\"deviceType\":\"" + device.deviceType + "\"";
1816 sequenceJson = sequenceJson.replace(deviceType.subSequence(0, deviceType.length()),
1817 newDeviceType.subSequence(0, newDeviceType.length()));
1819 // "deviceSerialNumber":"ALEXA_CURRENT_DSN"
1820 String deviceSerial = "\"deviceSerialNumber\":\"ALEXA_CURRENT_DSN\"";
1821 String newDeviceSerial = "\"deviceSerialNumber\":\"" + device.serialNumber + "\"";
1822 sequenceJson = sequenceJson.replace(deviceSerial.subSequence(0, deviceSerial.length()),
1823 newDeviceSerial.subSequence(0, newDeviceSerial.length()));
1825 // "customerId": "ALEXA_CUSTOMER_ID"
1826 String customerId = "\"customerId\":\"ALEXA_CUSTOMER_ID\"";
1827 String newCustomerId = "\"customerId\":\"" + getCustomerId(device.deviceOwnerCustomerId) + "\"";
1828 sequenceJson = sequenceJson.replace(customerId.subSequence(0, customerId.length()),
1829 newCustomerId.subSequence(0, newCustomerId.length()));
1831 // "locale": "ALEXA_CURRENT_LOCALE"
1832 String locale = "\"locale\":\"ALEXA_CURRENT_LOCALE\"";
1833 String newlocale = deviceLocale != null && !deviceLocale.isEmpty() ? "\"locale\":\"" + deviceLocale + "\""
1834 : "\"locale\":null";
1835 sequenceJson = sequenceJson.replace(locale.subSequence(0, locale.length()),
1836 newlocale.subSequence(0, newlocale.length()));
1838 request.sequenceJson = sequenceJson;
1840 String requestJson = gson.toJson(request);
1841 makeRequest("POST", alexaServer + "/api/behaviors/preview", requestJson, true, true, null, 3);
1843 logger.warn("Routine {} not found", utterance);
1847 public @Nullable JsonAutomation @Nullable [] getRoutines()
1848 throws IOException, URISyntaxException, InterruptedException {
1849 String json = makeRequestAndReturnString(alexaServer + "/api/behaviors/automations?limit=2000");
1850 JsonAutomation[] result = parseJson(json, JsonAutomation[].class);
1854 public JsonFeed[] getEnabledFlashBriefings() throws IOException, URISyntaxException, InterruptedException {
1855 String json = makeRequestAndReturnString(alexaServer + "/api/content-skills/enabled-feeds");
1856 JsonEnabledFeeds result = parseJson(json, JsonEnabledFeeds.class);
1857 if (result == null) {
1858 return new JsonFeed[0];
1860 JsonFeed[] enabledFeeds = result.enabledFeeds;
1861 if (enabledFeeds != null) {
1862 return enabledFeeds;
1864 return new JsonFeed[0];
1867 public void setEnabledFlashBriefings(JsonFeed[] enabledFlashBriefing)
1868 throws IOException, URISyntaxException, InterruptedException {
1869 JsonEnabledFeeds enabled = new JsonEnabledFeeds();
1870 enabled.enabledFeeds = enabledFlashBriefing;
1871 String json = gsonWithNullSerialization.toJson(enabled);
1872 makeRequest("POST", alexaServer + "/api/content-skills/enabled-feeds", json, true, true, null, 0);
1875 public JsonNotificationSound[] getNotificationSounds(Device device)
1876 throws IOException, URISyntaxException, InterruptedException {
1877 String json = makeRequestAndReturnString(
1878 alexaServer + "/api/notification/sounds?deviceSerialNumber=" + device.serialNumber + "&deviceType="
1879 + device.deviceType + "&softwareVersion=" + device.softwareVersion);
1880 JsonNotificationSounds result = parseJson(json, JsonNotificationSounds.class);
1881 if (result == null) {
1882 return new JsonNotificationSound[0];
1884 JsonNotificationSound[] notificationSounds = result.notificationSounds;
1885 if (notificationSounds != null) {
1886 return notificationSounds;
1888 return new JsonNotificationSound[0];
1891 public JsonNotificationResponse[] notifications() throws IOException, URISyntaxException, InterruptedException {
1892 String response = makeRequestAndReturnString(alexaServer + "/api/notifications");
1893 JsonNotificationsResponse result = parseJson(response, JsonNotificationsResponse.class);
1894 if (result == null) {
1895 return new JsonNotificationResponse[0];
1897 JsonNotificationResponse[] notifications = result.notifications;
1898 if (notifications == null) {
1899 return new JsonNotificationResponse[0];
1901 return notifications;
1904 public @Nullable JsonNotificationResponse notification(Device device, String type, @Nullable String label,
1905 @Nullable JsonNotificationSound sound) throws IOException, URISyntaxException, InterruptedException {
1906 Date date = new Date(new Date().getTime());
1907 long createdDate = date.getTime();
1908 Date alarm = new Date(createdDate + 5000); // add 5 seconds, because amazon does not except calls for times in
1909 // the past (compared with the server time)
1910 long alarmTime = alarm.getTime();
1912 JsonNotificationRequest request = new JsonNotificationRequest();
1913 request.type = type;
1914 request.deviceSerialNumber = device.serialNumber;
1915 request.deviceType = device.deviceType;
1916 request.createdDate = createdDate;
1917 request.alarmTime = alarmTime;
1918 request.reminderLabel = label;
1919 request.sound = sound;
1920 request.originalDate = new SimpleDateFormat("yyyy-MM-dd").format(alarm);
1921 request.originalTime = new SimpleDateFormat("HH:mm:ss.SSSS").format(alarm);
1922 request.type = type;
1923 request.id = "create" + type;
1925 String data = gsonWithNullSerialization.toJson(request);
1926 String response = makeRequestAndReturnString("PUT", alexaServer + "/api/notifications/createReminder", data,
1928 JsonNotificationResponse result = parseJson(response, JsonNotificationResponse.class);
1932 public void stopNotification(JsonNotificationResponse notification)
1933 throws IOException, URISyntaxException, InterruptedException {
1934 makeRequestAndReturnString("DELETE", alexaServer + "/api/notifications/" + notification.id, null, true, null);
1937 public @Nullable JsonNotificationResponse getNotificationState(JsonNotificationResponse notification)
1938 throws IOException, URISyntaxException, InterruptedException {
1939 String response = makeRequestAndReturnString("GET", alexaServer + "/api/notifications/" + notification.id, null,
1941 JsonNotificationResponse result = parseJson(response, JsonNotificationResponse.class);
1945 public List<JsonMusicProvider> getMusicProviders() {
1947 Map<String, String> headers = new HashMap<>();
1948 headers.put("Routines-Version", "1.1.218665");
1949 String response = makeRequestAndReturnString("GET",
1950 alexaServer + "/api/behaviors/entities?skillId=amzn1.ask.1p.music", null, true, headers);
1951 if (!response.isEmpty()) {
1952 JsonMusicProvider[] result = parseJson(response, JsonMusicProvider[].class);
1953 return Arrays.asList(result);
1955 } catch (IOException | URISyntaxException | InterruptedException e) {
1956 logger.warn("getMusicProviders fails: {}", e.getMessage());
1961 public void playMusicVoiceCommand(Device device, String providerId, String voiceCommand)
1962 throws IOException, URISyntaxException, InterruptedException {
1963 JsonPlaySearchPhraseOperationPayload payload = new JsonPlaySearchPhraseOperationPayload();
1964 payload.customerId = getCustomerId(device.deviceOwnerCustomerId);
1965 payload.locale = "ALEXA_CURRENT_LOCALE";
1966 payload.musicProviderId = providerId;
1967 payload.searchPhrase = voiceCommand;
1969 String playloadString = gson.toJson(payload);
1971 JsonObject postValidationJson = new JsonObject();
1973 postValidationJson.addProperty("type", "Alexa.Music.PlaySearchPhrase");
1974 postValidationJson.addProperty("operationPayload", playloadString);
1976 String postDataValidate = postValidationJson.toString();
1978 String validateResultJson = makeRequestAndReturnString("POST",
1979 alexaServer + "/api/behaviors/operation/validate", postDataValidate, true, null);
1981 if (!validateResultJson.isEmpty()) {
1982 JsonPlayValidationResult validationResult = parseJson(validateResultJson, JsonPlayValidationResult.class);
1983 if (validationResult != null) {
1984 JsonPlaySearchPhraseOperationPayload validatedOperationPayload = validationResult.operationPayload;
1985 if (validatedOperationPayload != null) {
1986 payload.sanitizedSearchPhrase = validatedOperationPayload.sanitizedSearchPhrase;
1987 payload.searchPhrase = validatedOperationPayload.searchPhrase;
1992 payload.locale = null;
1993 payload.deviceSerialNumber = device.serialNumber;
1994 payload.deviceType = device.deviceType;
1996 JsonObject sequenceJson = new JsonObject();
1997 sequenceJson.addProperty("@type", "com.amazon.alexa.behaviors.model.Sequence");
1998 JsonObject startNodeJson = new JsonObject();
1999 startNodeJson.addProperty("@type", "com.amazon.alexa.behaviors.model.OpaquePayloadOperationNode");
2000 startNodeJson.addProperty("type", "Alexa.Music.PlaySearchPhrase");
2001 startNodeJson.add("operationPayload", gson.toJsonTree(payload));
2002 sequenceJson.add("startNode", startNodeJson);
2004 JsonStartRoutineRequest startRoutineRequest = new JsonStartRoutineRequest();
2005 startRoutineRequest.sequenceJson = sequenceJson.toString();
2006 startRoutineRequest.status = null;
2008 String postData = gson.toJson(startRoutineRequest);
2009 makeRequest("POST", alexaServer + "/api/behaviors/preview", postData, true, true, null, 3);
2012 public @Nullable JsonEqualizer getEqualizer(Device device)
2013 throws IOException, URISyntaxException, InterruptedException {
2014 String json = makeRequestAndReturnString(
2015 alexaServer + "/api/equalizer/" + device.serialNumber + "/" + device.deviceType);
2016 return parseJson(json, JsonEqualizer.class);
2019 public void setEqualizer(Device device, JsonEqualizer settings)
2020 throws IOException, URISyntaxException, InterruptedException {
2021 String postData = gson.toJson(settings);
2022 makeRequest("POST", alexaServer + "/api/equalizer/" + device.serialNumber + "/" + device.deviceType, postData,
2023 true, true, null, 0);
2026 private static class Announcement {
2027 public List<Device> devices = new ArrayList<>();
2028 public String speak;
2029 public String bodyText;
2030 public @Nullable String title;
2031 public List<@Nullable Integer> ttsVolumes = new ArrayList<>();
2032 public List<@Nullable Integer> standardVolumes = new ArrayList<>();
2034 public Announcement(String speak, String bodyText, @Nullable String title) {
2036 this.bodyText = bodyText;
2041 private static class TextToSpeech {
2042 public List<Device> devices = new ArrayList<>();
2044 public List<@Nullable Integer> ttsVolumes = new ArrayList<>();
2045 public List<@Nullable Integer> standardVolumes = new ArrayList<>();
2047 public TextToSpeech(String text) {
2052 private static class Volume {
2053 public List<Device> devices = new ArrayList<>();
2055 public List<@Nullable Integer> volumes = new ArrayList<>();
2057 public Volume(int volume) {
2058 this.volume = volume;
2062 private static class QueueObject {
2063 public @Nullable Future<?> future;
2064 public List<Device> devices = List.of();
2065 public JsonObject nodeToExecute = new JsonObject();
2068 private static class ExecutionNodeObject {
2069 public List<String> types = new ArrayList<>();