Copyright 2022 Snap One All rights reserved.74Snap OneSnap OneLuma IP Camera PTZPTZ12/4/2017 5:00 PM03/26/2024 12:55 PMdevices_sm/camera_sm.gifdevices_lg/camera_lg.giflua_geniptrueLuma Surveillance:camera:ptz_cameraCamerascameraDriverWorksSNAPSHOT, H264TrueFalseTrueFalseTrueTrue2080554TrueBASICadminadminFalseFalseTrueTrue1003IMAGE_JPEGSnapshot (URL)1Input TriggerWhen NAME detected Input Trigger2Field DetectionWhen NAME detected Field Detection3MotionWhen NAME detected Motion4GroupWhen NAME detected Group5ParkingWhen NAME detected Parking6Line DetectionWhen NAME detected Line Detection7Rapid MoveWhen NAME detected Rapid Move8Region EntranceWhen NAME detected Region Entrance9LoiteringWhen NAME detected Loitering10Scene ChangedWhen NAME detected Scene Changed11DefocusWhen NAME detected Defocus12People DetectionWhen NAME detected People Detection13PIRWhen NAME detected PIR14Shelter AlarmWhen NAME detected Shelter Alarm15Attended BaggageWhen NAME detected Attended Baggage16Face DetectionWhen NAME detected Face Detection17Unattended BaggageWhen NAME detected Unattended Baggage18Region ExitingWhen NAME detected Region ExitingAdd and Connect EventsAddContactsEventCUSTOM_SELECT:GetEventsForActionSet As PresetSetAsPresetPreset NumberRANGED_INTEGER18Set As Home PositionSetAsHomePositionSync TimeTimeRotate ImageCenterOriginal ImageCloseReboot CameraRebootPrivacy MaskChange privacy mask to PARAM1EnableLISTONOFFGo To PresetGo To Preset PARAM1 on NAMEPreset NumberRANGED_INTEGER1300Driver VersionSTRINGtrueStatusSTRINGOfflinetrueInternal IP AddressSTRINGtrueMAC AddressSTRINGtrueModelSTRINGtrueFirmware VersionSTRINGtrueService TagSTRINGtrueSerial NumberSTRINGtrueCamera NumberRANGED_INTEGER1116falsePTZ SpeedRANGED_INTEGER317falseConnection MethodLISTfalseSwitchSwitchLuma NVRLuma X20 NVRNotificationsLISTfalseDisableEnableDisableNotification IntervalRANGED_INTEGER2110falseEvent Debounce TimerRANGED_INTEGER5160falseDEBUG MODELISTfalseOFFOFFON
Luma X10 Cameras
-------------------------------------------------------------------------------------------
ONLINE DOCUMENTATION
-------------------------------------------------------------------------------------------
Manufacturer Website: https://snapone.com/
Support Site: https://snapone.com/contact-us
Configuring Luma with Control4: https://tech.control4.com/Technician/s/article/Setting-Up-Luma-Cameras-With-Control4
-------------------------------------------------------------------------------------------
OVERVIEW
-------------------------------------------------------------------------------------------
This driver integrates a Luma X10 IP Camera into Control4. This device can be discovered via SDDP and should be identified that way to ensure connectivity if the IP changes.
*NOTE* When consecutively enabling or disabling multiple cameras, you should add a 1 or 2 second delay to ensure that each command is properly executed.
*NOTE* due to firmware limitations in Luma cameras, passwords with 16 or more characters will not function with this driver. Limit password length to a maximum of 15 characters.
-------------------------------------------------------------------------------------------
X10 FISHEYE MODES
-------------------------------------------------------------------------------------------
Fisheye+3PTZ:
Stream 1 = Fisheye Main Stream
Stream 1 = Fisheye Sub Stream
Stream 2 = PTZ 1 Main Stream
Stream 3 = PTZ 2 Main Streem
Stream 4 = PTZ 3 Main Stream
SNAPSHOT SUPPORTED [Fisheye Only]
MJPEG SUPPORT [Fisheye Only]
Fisheye+2PTZ [DEFAULT]:
Stream 1 = Fisheye Main Stream
Stream 1 = Fisheye Sub Stream
Stream 2 = PTZ 1 Main Stream
Stream 2 = PTZ 1 Sub Stream
Stream 3 = PTZ 2 Main Stream
Stream 3 = PTZ 2 Sub Stream
NO SNAPSHOT
Fisheye+PTZ:
Stream 1 = Fisheye Main Stream
Stream 1 = Fisheye Sub Stream
Stream 2 = PTZ 1 Main Stream
Stream 2 = PTZ 1 Sub Stream
SNAPSHOT SUPPORTED
2PTZ:
Stream 1 = PTZ 1 Main Stream
Stream 1 = PTZ 1 Sub Stream
Stream 2 = PTZ 2 Main Stream
Stream 2 = PTZ 2 Sub Stream
SNAPSHOT SUPPORTED
*NOTE* For each stream a separate instance of the driver should be installed. Each of these additional drivers should have their Stream Number property set to the corresponding camera stream.
-------------------------------------------------------------------------------------------
SETUP
-------------------------------------------------------------------------------------------
*** IMPORTANT ***
On X10 and newer Luma cameras, enable the third stream for control system integration. Selecting "Third Stream" from the driver's drop down menu will automatically enable the third stream if not already on. When this setting is changed the camera will reboot so you will lose connectivity for several minutes. As of version 69 of the driver, due to proxy updates, third stream is automatically enabled and stream type has been removed.
If you wish to manually enable the third stream: Log into the camera's local UI, select the "Configuration" icon, and under the "System Settings" section, select "Hardware Settings" and verify the "Enable Third Stream" check box is selected.
***
*** IMPORTANT ***
When using this driver in the configuration of a camera connected behind a NVR, the camera and the NVR must match their credentials for all features to function properly.
When using the x20 NVR with x10 IP Cameras:
1. Under user management, create a new SystemConnect user on the x10 IP camera using same SystemConnect user and password as the x20 NVR.
2. Under advanced network settings, in the integration protocol menu, enable onvif and create a new SystemConnect user using the same SystemConnect user and password as the x20 NVR.
3. Ensure there are no firmware updates avaliable in OvrC for x10 camera.
4. Make sure it is set to DHCP then disconnect it.
5. Connect the x10 IP camera to the x20 NVR built in PoE switch.
6. Set the credentials of the camera to match the SystemConnect credentials when the NVR discovers the camera in the camera list.
7. Camera will be connected in 2-3 minutes.
8. Camera is ready to be integrated with the driver.
X10 protocol will be selected automatically when adding a x10 camera. This protocol allows all 3 streams of the camera to be avaliable through the NVR.
***
1. Auto add the driver under the discovered tab or manually add the driver to the project.
2. If added through the Discovered tab, the IP address and connection string will automatically populate in the driver. If added manually, identify the camera via its connection string or IP address in Composer's Network Connections tab. If the camera is directly connected to an Ethernet port on the back of an NVR, enter the IP address of the NVR in place of the camera's IP address.
3. Once identified, enter the correct port information into the Camera Properties of the driver. Do this per the camera's connection method. See below for details:
Typical Port Configurations
Luma NVR - HTTP Port = Virtual port direct to camera; typically 6500X where X is the camera number. EG: 65003 for camera 3. (This can also be found in the NVR's web interface under the Camera Management Menu), RTSP Port = NVR port (554) Switch - HTTP Port = Camera's HTTP port, RTSP Port = Camera's RTSP port
4. Enter the camera's Username and Password into the driver properties. When connected through the NVR, the camera's credentials should still be used.
5. Test the streams to ensure the driver is communicating with the camera correctly. The primary stream of the camera should be set to maximum resolution for recordings. The second and third stream should both be set to H.264. Whichever stream you are using for integration for Control4 should be set to 720P or less for optimal compatibility. MJPEG is no longer supported in the driver. As of version 69, all streams are provided to the navigators so they can select the optimal one for experience. If a legacy UI device is within the project, ensure atleast one stream is set to 720p.
6. Fill out the remaining properties if notifications are desired. For smart and motion events to function, they must be enabled through the camera, or NVR if applicable, user interface. The network connection IP address must also be populated in order for the driver to establish the appropriate connection to the event stream.
7. If using either motion detection or smart events, add generic contact sensors to the project and bind them up to the motion and input trigger connections. The Add and connect contacts action button can help create and bind these for you.
8. Refresh navigators.
-------------------------------------------------------------------------------------------
PROPERTIES
-------------------------------------------------------------------------------------------
Driver Version
Indicates the current driver version
Status
Indicates current network status of camera. The camera is polled every 60 seconds to check network connectivity
Internal IP Address
Indicates the current IP address given internally by an NVR.
MAC Address
Indicates the MAC Address of the camera
Model
Indicates the model of the camera
Firmware Version
Indicates the firmware version of the camera
Service Tag
Indicates the service tag of the camera
Serial Number
Indicates the serial number of the camera
Camera Number
Number of camera
Fisheye Mode (Fisheye Only)
Current fisheye mode of the camera
Stream Number (Fisheye Only)
Current stream number of the camera
Stream Type (Removed as of version 69)
Mainstream - Primary stream which shouldn't normally be used and reserved for high resolution recordings
Substream - Lower quality stream which should be set to H264 and 720P or less for optimal Control4 integration
Third Stream - Preferred, High quality H264 stream for Control4
PTZ Speed (X10 PTZ Only)
Speed at which PTZ commands are executed. Range is between 1-7 and 3 is default.
Connection Method
Switch - Use when the camera is connected to a network switch on the same network as Control4
Luma NVR - Use when the camera is plugged into the PoE ports behind the a x10 Luma Series Recorder
- (Fisheye Only) NVR Stream Type property will become visible with this option selected
Luma X20 NVR - Use when the camera is plugged into the PoE ports behind the a x20 Luma Series Recorder. When selecting this property, the stream type will automatically change to third stream.
NVR Stream Type (Fisheye Only)
When connecting the Fisheye camera to a Luma NVR, select the view you would like this
driver to display. Please note, some views are unsupported depending on the current mode of the Fisheye Camera. PTZ 3 is unsupported all together since MJPEG is unsupported for everything but Fisheye when in Fisheye+3PTZ mode.
Fisheye
PTZ 1
PTZ 2
Notifications
Enable or disable smart events and motion events. When enabled for the first time, a motion contact sensor will automatically
be added and bound to the motion connection binding.
Smart Event Descriptions:
Video Loss = video streaming is lost, no video transferred
Shelter Alarm = lens is covered by something
Face Detection = human face appears in the scene
Defocus = camera is out of focus
Scene Change Detection = the scene or field camera monitors has changed
Field Detection = same as the intrusion detection event defined in the camera
Line Detection = same as line crossing detection event defined in the camera
Region Entrance = someone or an object enters a region defined in the camera
Region Exiting = someone or an object exits a region defined in the camera
Loitering = someone or an object loiters at a region. For example, a thief would loiter at outside of shop to watch inside.
Group = identifies a crowd of people gathering
Rapid Move = someone or an object moves quickly in the field of view
Parking = a vehicle parks in the scene
Unattended Baggage = someone leaves an object in the field of view. For example, person forgets his baggage when rushing for a flight
Attended Baggage = someone picks an object which already exists at scene before the person entered the scene
PIR = For cameras that have a PIR sensor, if the sensor detects an infrared signal this will be tripped.
People Detection = human body(s) appear at scene
Notification Interval
Time, in seconds, to open the contact when event is detected. If a reoccuring event is triggered this time will be reset.
Event Debounce Timer
Time, in seconds, to wait to fire another event. Avoids rapid event firing when a reoccuring event is triggered.
DEBUG MODE
Used for debugging the lua output window
-------------------------------------------------------------------------------------------
EVENTS
-------------------------------------------------------------------------------------------
Input Trigger
Field Detection
Motion
Group
Parking
Line Detection
Rapid Move
Region Entrance
Loitering
Scene Changed
Defocus
People Detection
PIR
Shelter Alarm
Attended Baggage
Face Detection
Unattended Baggage
Region Exiting
-------------------------------------------------------------------------------------------
ACTIONS
-------------------------------------------------------------------------------------------
Add and Connect Contacts:
Creates and auto binds contacts to this driver's contact sensor connections.
Reboot Camera:
Will cause the camera to reboot - It may be several minutes before the camera is back online.
Original Image:
This removes any mirror or flip on the camera image.
Rotate Image:
Rotates the image around a central point.
Sync Time:
Will synchronize the camera time to the controller's time.
Get Current Mode: (Fisheye Only)
Gathers the current mode that the fisheye camera is set to. i.e. Fisheye + 1PTZ
This action must be taken when changing modes on the camera in order to gather
the correct streams.
-------------------------------------------------------------------------------------------
DEVICE-SPECIFIC COMMANDS
-------------------------------------------------------------------------------------------
Privacy Mask: Set privacy mask on/off
Go To Preset: Recall preset 1-300
-------------------------------------------------------------------------------------------
CHANGE LOG
-------------------------------------------------------------------------------------------
v74
Fixed a bug where @ was in the password by URL encoding the password
v73
Added support for digest authentication to the api and event port
v72
Fixed bug where driver wasnt deleting old cached streams
v71
Added support for monitoring ip when driver is configured behind an NVR
v70
Moved proxy notification to late init
v69
Updated static and ptz drivers to support new camera proxy functionality
v68
Added data to help insights efforts
v67
Corrected third stream to spe for x10 behind x20
v66
Added back third stream for x10 behind x20
v65
Documentation update
v64
Reverted v62 fix due to 403 forbidden errors
v63
Resolved lua error with PTZ functionality
v62
Resolved snapshot password length issue
v61
Resolved streaming issues with x10 behind x20 nvr
v59
Resolve bug with rendering property details of x10 behind x20
v57
Added support for snapshot of x10 behind x20 nvr
v56
Added support for streaming x10 behind x20 nvr
v54
Added motion detection and alarm triggered events
Debounce event timer
v53
Fixed privacy mask bug around masking entire view regardless of area box
v52
Added support for setting privacy mask
v51
Modified auto port configuration logic
v50
Fixed fisheye stream type when connected to NVR
v49
Fixed fisheye snapshot attachment
v48
Fixed PTZ pan left bug
v47
Notifications support for NVR connection method
v46
Fixed fisheye snapshot url
v45
Updated documentation
v44
Fixed stream type property causing gstreamer error
v43
Added driver version
Added firmware version
Added service tag
Modified relay poe logic
v42
Account credential fixes
Snapshot attachment fixes
v41
Code rewrite
v40
Documentation update
v39
Fixed bug around adding all events
v38
Fixed lua error around "Add and Connect Events" Action button
Added recalling presets and home
v37
Fixed luma errors around third stream enablement
v36
Added action buttons
v35
Convert change log revisions to use driver version
Enhance connection logic to handle reconnecting and subscribing to
smart motion events
v3.2
Overhaul of motion and input events
Added smart motion events
v3.1
Removed MJPEG stream
v3.0
Added documentation note about spacing out commands
v2.9
Added back resolution hardcoded to 640x480
Removed stream type
v2.8
Fixed steam type for snapshot and mjpeg to 2
Removed format and resolution
v2.7
Reverted third stream H264 Configuration
v2.6
Auto configure the HTTP Port based on connection method
v2.5
Hide password
v2.4
Fixed Luma NVR and Third Stream H264 configuration
v2.3
Fixed motion event memory consumption issue
v2.2
Network tools status
v2.1
Added support for notifications snapshot
v2.0
Added authentication to all commands
v1.9
Changes for certification
v1.8
Changes for certification
v1.7
Changes for certification
v1.6
Changes for certification
v1.5
Changes for certification
v1.4
Documentation updates
v1.3
Changes for certification
v1.2
Removed configurable event port
Event port automatically generated based on Control4 API
Added status property
Added model property
v1.1
Randomize event port
v1.0
Release
-------------------------------------------------------------------------------------------
16Motion1FalseFalseFalseFalseCONTACT_SENSOR26Input Trigger1FalseFalseFalseFalseCONTACT_SENSOR46Shelter Alarm1FalseFalseFalseFalseCONTACT_SENSOR56Face Detection1FalseFalseFalseFalseCONTACT_SENSOR66Defocus1FalseFalseFalseFalseCONTACT_SENSOR76Scene Changed1FalseFalseFalseFalseCONTACT_SENSOR86Field Detection1FalseFalseFalseFalseCONTACT_SENSOR96Line Detection1FalseFalseFalseFalseCONTACT_SENSOR106Region Entrance1FalseFalseFalseFalseCONTACT_SENSOR116Region Exiting1FalseFalseFalseFalseCONTACT_SENSOR126Loitering1FalseFalseFalseFalseCONTACT_SENSOR136Group1FalseFalseFalseFalseCONTACT_SENSOR146Rapid Move1FalseFalseFalseFalseCONTACT_SENSOR156Parking1FalseFalseFalseFalseCONTACT_SENSOR166Unattended Baggage1FalseFalseFalseFalseCONTACT_SENSOR176Attended Baggage1FalseFalseFalseFalseCONTACT_SENSOR186PIR1FalseFalseFalseFalseCONTACT_SENSOR196People Detection1FalseFalseFalseFalseCONTACT_SENSOR50016Camera2FalseFalseFalseFalseCAMERATrue60016Network Connection4TrueFalseFalseTrueTCP80FalseFalseFalseFalse