2 * Copyright (c) 2010-2021 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.sonos.internal;
15 import java.util.HashSet;
17 import java.util.stream.Collectors;
18 import java.util.stream.Stream;
20 import org.eclipse.jdt.annotation.NonNullByDefault;
21 import org.openhab.core.thing.ThingTypeUID;
24 * The {@link SonosBinding} class defines common constants, which are
25 * used across the whole binding.
27 * @author Karel Goderis - Initial contribution
28 * @author Kai Kreuzer - Changed ESH-PREFIX and cleaned up warnings
31 public class SonosBindingConstants {
33 public static final String BINDING_ID = "sonos";
34 public static final String TITLE_PREFIX = "smarthome-";
36 // List of all Thing Type UIDs
37 // Column (:) is not used for PLAY:1, PLAY:3, PLAY:5 and CONNECT:AMP because of
38 // ThingTypeUID and device pairing name restrictions
39 public static final ThingTypeUID ONE_THING_TYPE_UID = new ThingTypeUID(BINDING_ID, "One");
40 public static final ThingTypeUID ONE_SL_THING_TYPE_UID = new ThingTypeUID(BINDING_ID, "OneSL");
41 public static final ThingTypeUID PLAY1_THING_TYPE_UID = new ThingTypeUID(BINDING_ID, "PLAY1");
42 public static final ThingTypeUID PLAY3_THING_TYPE_UID = new ThingTypeUID(BINDING_ID, "PLAY3");
43 public static final ThingTypeUID PLAY5_THING_TYPE_UID = new ThingTypeUID(BINDING_ID, "PLAY5");
44 public static final ThingTypeUID PLAYBAR_THING_TYPE_UID = new ThingTypeUID(BINDING_ID, "PLAYBAR");
45 public static final ThingTypeUID PLAYBASE_THING_TYPE_UID = new ThingTypeUID(BINDING_ID, "PLAYBASE");
46 public static final ThingTypeUID BEAM_THING_TYPE_UID = new ThingTypeUID(BINDING_ID, "Beam");
47 public static final ThingTypeUID CONNECT_THING_TYPE_UID = new ThingTypeUID(BINDING_ID, "CONNECT");
48 public static final ThingTypeUID PORT_THING_TYPE_UID = new ThingTypeUID(BINDING_ID, "Port");
49 public static final ThingTypeUID CONNECTAMP_THING_TYPE_UID = new ThingTypeUID(BINDING_ID, "CONNECTAMP");
50 public static final ThingTypeUID AMP_THING_TYPE_UID = new ThingTypeUID(BINDING_ID, "Amp");
51 public static final ThingTypeUID SYMFONISK_THING_TYPE_UID = new ThingTypeUID(BINDING_ID, "SYMFONISK");
52 public static final ThingTypeUID ZONEPLAYER_THING_TYPE_UID = new ThingTypeUID(BINDING_ID, "zoneplayer");
54 public static final Set<ThingTypeUID> WITH_LINEIN_THING_TYPES_UIDS = Stream
55 .of(PLAY5_THING_TYPE_UID, PLAYBAR_THING_TYPE_UID, PLAYBASE_THING_TYPE_UID, BEAM_THING_TYPE_UID,
56 CONNECT_THING_TYPE_UID, CONNECTAMP_THING_TYPE_UID, PORT_THING_TYPE_UID)
57 .collect(Collectors.toSet());
59 public static final Set<ThingTypeUID> WITH_ANALOG_LINEIN_THING_TYPES_UIDS = Stream.of(AMP_THING_TYPE_UID)
60 .collect(Collectors.toSet());
62 public static final Set<ThingTypeUID> WITH_DIGITAL_LINEIN_THING_TYPES_UIDS = Stream.of(AMP_THING_TYPE_UID)
63 .collect(Collectors.toSet());
65 public static final Set<ThingTypeUID> SUPPORTED_KNOWN_THING_TYPES_UIDS = Stream.of(ONE_THING_TYPE_UID,
66 ONE_SL_THING_TYPE_UID, PLAY1_THING_TYPE_UID, PLAY3_THING_TYPE_UID, PLAY5_THING_TYPE_UID,
67 PLAYBAR_THING_TYPE_UID, PLAYBASE_THING_TYPE_UID, BEAM_THING_TYPE_UID, CONNECT_THING_TYPE_UID,
68 CONNECTAMP_THING_TYPE_UID, PORT_THING_TYPE_UID, AMP_THING_TYPE_UID, SYMFONISK_THING_TYPE_UID)
69 .collect(Collectors.toSet());
71 public static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = new HashSet<>(SUPPORTED_KNOWN_THING_TYPES_UIDS);
73 SUPPORTED_THING_TYPES_UIDS.add(ZONEPLAYER_THING_TYPE_UID);
76 // List of all Channel ids
77 public static final String ADD = "add";
78 public static final String ALARM = "alarm";
79 public static final String ALARMPROPERTIES = "alarmproperties";
80 public static final String ALARMRUNNING = "alarmrunning";
81 public static final String CLEARQUEUE = "clearqueue";
82 public static final String CONTROL = "control";
83 public static final String COORDINATOR = "coordinator";
84 public static final String CURRENTALBUM = "currentalbum";
85 public static final String CURRENTALBUMART = "currentalbumart";
86 public static final String CURRENTALBUMARTURL = "currentalbumarturl";
87 public static final String CURRENTARTIST = "currentartist";
88 public static final String CURRENTTITLE = "currenttitle";
89 public static final String CURRENTTRACK = "currenttrack";
90 public static final String CURRENTTRACKURI = "currenttrackuri";
91 public static final String CURRENTTRANSPORTURI = "currenttransporturi";
92 public static final String FAVORITE = "favorite";
93 public static final String LED = "led";
94 public static final String LINEIN = "linein";
95 public static final String ANALOGLINEIN = "analoglinein";
96 public static final String DIGITALLINEIN = "digitallinein";
97 public static final String LOCALCOORDINATOR = "localcoordinator";
98 public static final String MUTE = "mute";
99 public static final String NIGHTMODE = "nightmode";
100 public static final String NOTIFICATIONSOUND = "notificationsound";
101 public static final String PLAYLINEIN = "playlinein";
102 public static final String PLAYLIST = "playlist";
103 public static final String PLAYQUEUE = "playqueue";
104 public static final String PLAYTRACK = "playtrack";
105 public static final String PLAYURI = "playuri";
106 public static final String PUBLICADDRESS = "publicaddress";
107 public static final String PUBLICANALOGADDRESS = "publicanalogaddress";
108 public static final String PUBLICDIGITALADDRESS = "publicdigitaladdress";
109 public static final String RADIO = "radio";
110 public static final String REMOVE = "remove";
111 public static final String REPEAT = "repeat";
112 public static final String RESTORE = "restore";
113 public static final String RESTOREALL = "restoreall";
114 public static final String SAVE = "save";
115 public static final String SAVEALL = "saveall";
116 public static final String SHUFFLE = "shuffle";
117 public static final String SLEEPTIMER = "sleeptimer";
118 public static final String SNOOZE = "snooze";
119 public static final String SPEECHENHANCEMENT = "speechenhancement";
120 public static final String STANDALONE = "standalone";
121 public static final String STATE = "state";
122 public static final String STOP = "stop";
123 public static final String TUNEINSTATIONID = "tuneinstationid";
124 public static final String VOLUME = "volume";
125 public static final String ZONEGROUPID = "zonegroupid";
126 public static final String ZONENAME = "zonename";
127 public static final String MODELID = "modelId";
129 // List of properties
130 public static final String IDENTIFICATION = "identification";
131 public static final String MAC_ADDRESS = "macAddress";
132 public static final String IP_ADDRESS = "ipAddress";