2 * Copyright (c) 2010-2024 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.ipcamera.internal;
15 import java.math.BigDecimal;
16 import java.util.Arrays;
17 import java.util.HashSet;
20 import org.eclipse.jdt.annotation.NonNullByDefault;
21 import org.openhab.core.thing.ThingTypeUID;
24 * The {@link IpCameraBindingConstants} class defines common constants, which
25 * are used across the whole binding.
27 * @author Matthew Skinner - Initial contribution
30 public class IpCameraBindingConstants {
31 private static final String BINDING_ID = "ipcamera";
32 public static final String AUTH_HANDLER = "authorizationHandler";
33 public static final String AMCREST_HANDLER = "amcrestHandler";
34 public static final String COMMON_HANDLER = "commonHandler";
35 public static final String INSTAR_HANDLER = "instarHandler";
36 public static final String REOLINK_HANDLER = "reolinkHandler";
37 public static final String HIKVISION_HANDLER = "hikvisionHandler";
39 public enum FFmpegFormat {
48 public static final BigDecimal BIG_DECIMAL_SCALE_MOTION = new BigDecimal(5000);
49 public static final long HLS_STARTUP_DELAY_MS = 4500;
50 @SuppressWarnings("null")
51 public static final int SERVLET_PORT = Integer.getInteger("org.osgi.service.http.port", 8080);
53 // List of all Thing Type UIDs
54 public static final ThingTypeUID THING_TYPE_GROUP = new ThingTypeUID(BINDING_ID, "group");
55 public static final String GENERIC_THING = "generic";
56 public static final ThingTypeUID THING_TYPE_GENERIC = new ThingTypeUID(BINDING_ID, GENERIC_THING);
57 public static final String ONVIF_THING = "onvif";
58 public static final ThingTypeUID THING_TYPE_ONVIF = new ThingTypeUID(BINDING_ID, ONVIF_THING);
59 public static final String AMCREST_THING = "amcrest";
60 public static final ThingTypeUID THING_TYPE_AMCREST = new ThingTypeUID(BINDING_ID, AMCREST_THING);
61 public static final String FOSCAM_THING = "foscam";
62 public static final ThingTypeUID THING_TYPE_FOSCAM = new ThingTypeUID(BINDING_ID, FOSCAM_THING);
63 public static final String HIKVISION_THING = "hikvision";
64 public static final ThingTypeUID THING_TYPE_HIKVISION = new ThingTypeUID(BINDING_ID, HIKVISION_THING);
65 public static final String INSTAR_THING = "instar";
66 public static final ThingTypeUID THING_TYPE_INSTAR = new ThingTypeUID(BINDING_ID, INSTAR_THING);
67 public static final String DAHUA_THING = "dahua";
68 public static final ThingTypeUID THING_TYPE_DAHUA = new ThingTypeUID(BINDING_ID, DAHUA_THING);
69 public static final String DOORBIRD_THING = "doorbird";
70 public static final ThingTypeUID THING_TYPE_DOORBIRD = new ThingTypeUID(BINDING_ID, DOORBIRD_THING);
71 public static final String REOLINK_THING = "reolink";
72 public static final ThingTypeUID THING_TYPE_REOLINK = new ThingTypeUID(BINDING_ID, REOLINK_THING);
74 public static final Set<ThingTypeUID> SUPPORTED_THING_TYPES = new HashSet<>(
75 Arrays.asList(THING_TYPE_ONVIF, THING_TYPE_GENERIC, THING_TYPE_AMCREST, THING_TYPE_DAHUA, THING_TYPE_INSTAR,
76 THING_TYPE_FOSCAM, THING_TYPE_DOORBIRD, THING_TYPE_HIKVISION, THING_TYPE_REOLINK));
78 public static final Set<ThingTypeUID> GROUP_SUPPORTED_THING_TYPES = new HashSet<>(Arrays.asList(THING_TYPE_GROUP));
80 // List of all Thing Config items
81 public static final String CONFIG_IPADDRESS = "ipAddress";
82 public static final String CONFIG_ONVIF_PORT = "onvifPort";
84 // List of all Channel ids
85 public static final String CHANNEL_POLL_IMAGE = "pollImage";
86 public static final String CHANNEL_RECORDING_GIF = "recordingGif";
87 public static final String CHANNEL_GIF_HISTORY = "gifHistory";
88 public static final String CHANNEL_GIF_HISTORY_LENGTH = "gifHistoryLength";
89 public static final String CHANNEL_RECORDING_MP4 = "recordingMp4";
90 public static final String CHANNEL_MP4_PREROLL = "mp4Preroll";
91 public static final String CHANNEL_MP4_HISTORY = "mp4History";
92 public static final String CHANNEL_MP4_HISTORY_LENGTH = "mp4HistoryLength";
93 public static final String CHANNEL_IMAGE = "image";
94 public static final String CHANNEL_RTSP_URL = "rtspUrl";
95 public static final String CHANNEL_IMAGE_URL = "imageUrl";
96 public static final String CHANNEL_MJPEG_URL = "mjpegUrl";
97 public static final String CHANNEL_HLS_URL = "hlsUrl";
98 public static final String CHANNEL_PAN = "pan";
99 public static final String CHANNEL_TILT = "tilt";
100 public static final String CHANNEL_ZOOM = "zoom";
101 public static final String CHANNEL_EXTERNAL_MOTION = "externalMotion";
102 public static final String CHANNEL_MOTION_ALARM = "motionAlarm";
103 public static final String CHANNEL_LINE_CROSSING_ALARM = "lineCrossingAlarm";
104 public static final String CHANNEL_FACE_DETECTED = "faceDetected";
105 public static final String CHANNEL_ITEM_LEFT = "itemLeft";
106 public static final String CHANNEL_ITEM_TAKEN = "itemTaken";
107 public static final String CHANNEL_AUDIO_ALARM = "audioAlarm";
108 public static final String CHANNEL_ENABLE_MOTION_ALARM = "enableMotionAlarm";
109 public static final String CHANNEL_FFMPEG_MOTION_CONTROL = "ffmpegMotionControl";
110 public static final String CHANNEL_FFMPEG_MOTION_ALARM = "ffmpegMotionAlarm";
111 public static final String CHANNEL_ENABLE_LINE_CROSSING_ALARM = "enableLineCrossingAlarm";
112 public static final String CHANNEL_ENABLE_AUDIO_ALARM = "enableAudioAlarm";
113 public static final String CHANNEL_THRESHOLD_AUDIO_ALARM = "thresholdAudioAlarm";
114 public static final String CHANNEL_ACTIVATE_ALARM_OUTPUT = "activateAlarmOutput";
115 public static final String CHANNEL_ACTIVATE_ALARM_OUTPUT2 = "activateAlarmOutput2";
116 public static final String CHANNEL_ENABLE_EXTERNAL_ALARM_INPUT = "enableExternalAlarmInput";
117 public static final String CHANNEL_TRIGGER_EXTERNAL_ALARM_INPUT = "triggerExternalAlarmInput";
118 public static final String CHANNEL_EXTERNAL_ALARM_INPUT = "externalAlarmInput";
119 public static final String CHANNEL_EXTERNAL_ALARM_INPUT2 = "externalAlarmInput2";
120 public static final String CHANNEL_AUTO_WHITE_LED = "autoWhiteLED";
121 public static final String CHANNEL_AUTO_LED = "autoLED";
122 public static final String CHANNEL_ENABLE_LED = "enableLED";
123 public static final String CHANNEL_WHITE_LED = "whiteLED";
124 public static final String CHANNEL_ENABLE_PIR_ALARM = "enablePirAlarm";
125 public static final String CHANNEL_PIR_ALARM = "pirAlarm";
126 public static final String CHANNEL_CELL_MOTION_ALARM = "cellMotionAlarm";
127 public static final String CHANNEL_ENABLE_FIELD_DETECTION_ALARM = "enableFieldDetectionAlarm";
128 public static final String CHANNEL_FIELD_DETECTION_ALARM = "fieldDetectionAlarm";
129 public static final String CHANNEL_PARKING_ALARM = "parkingAlarm";
130 public static final String CHANNEL_TAMPER_ALARM = "tamperAlarm";
131 public static final String CHANNEL_TOO_DARK_ALARM = "tooDarkAlarm";
132 public static final String CHANNEL_STORAGE_ALARM = "storageAlarm";
133 public static final String CHANNEL_SCENE_CHANGE_ALARM = "sceneChangeAlarm";
134 public static final String CHANNEL_TOO_BRIGHT_ALARM = "tooBrightAlarm";
135 public static final String CHANNEL_TOO_BLURRY_ALARM = "tooBlurryAlarm";
136 public static final String CHANNEL_TEXT_OVERLAY = "textOverlay";
137 public static final String CHANNEL_EXTERNAL_LIGHT = "externalLight";
138 public static final String CHANNEL_DOORBELL = "doorBell";
139 public static final String CHANNEL_LAST_MOTION_TYPE = "lastMotionType";
140 public static final String CHANNEL_LAST_EVENT_DATA = "lastEventData";
141 public static final String CHANNEL_GOTO_PRESET = "gotoPreset";
142 public static final String CHANNEL_START_STREAM = "startStream";
143 public static final String CHANNEL_ENABLE_PRIVACY_MODE = "enablePrivacyMode";
144 public static final String CHANNEL_CAR_ALARM = "carAlarm";
145 public static final String CHANNEL_HUMAN_ALARM = "humanAlarm";
146 public static final String CHANNEL_ANIMAL_ALARM = "animalAlarm";
147 public static final String CHANNEL_ENABLE_FTP = "enableFTP";
148 public static final String CHANNEL_ENABLE_EMAIL = "enableEmail";
149 public static final String CHANNEL_ENABLE_PUSH = "enablePush";
150 public static final String CHANNEL_ENABLE_RECORDINGS = "enableRecordings";