# UVC & Color Camera This example demonstrates how to use the RGB camera on your OAK device as a UVC webcam. The [UVC](https://docs.luxonis.com/software/depthai-components/nodes/uvc.md) node allows you to use your OAK device as a regular webcam in applications like OpenCV's cv2.VideoCapture(), native camera apps, and more. ### Similar samples: * [UVC & Disparity](https://docs.luxonis.com/software/depthai/examples/uvc_disparity.md) * [UVC & Mono Camera](https://docs.luxonis.com/software/depthai/examples/uvc_mono.md) ## Setup Please run the [install script](https://github.com/luxonis/depthai-python/blob/main/examples/install_requirements.py) to download all required dependencies. Please note that this script must be ran from git context, so you have to download the [depthai-python](https://github.com/luxonis/depthai-python) repository first and then run the script ```bash git clone https://github.com/luxonis/depthai-python.git cd depthai-python/examples python3 install_requirements.py ``` For additional information, please follow the [installation guide](https://docs.luxonis.com/software/depthai/manual-install.md). ## Code used for testing ```python import cv2 # Initialize the VideoCapture object to use the default camera (camera index 0 is webcam) cap = cv2.VideoCapture(1) # Check if the camera opened successfully if not cap.isOpened(): print("Error: Could not open camera.") exit() # Loop to continuously get frames from the camera while True: ret, frame = cap.read() if not ret: print("Error: Could not read frame.") break cv2.imshow('Video Feed', frame) if cv2.waitKey(1) & 0xFF == ord('q'): break cap.release() cv2.destroyAllWindows() ``` ## Source code #### Python ```python #!/usr/bin/env python3 import time import argparse parser = argparse.ArgumentParser() parser.add_argument('-fb', '--flash-bootloader', default=False, action="store_true") parser.add_argument('-f', '--flash-app', default=False, action="store_true") parser.add_argument('-l', '--load-and-exit', default=False, action="store_true") args = parser.parse_args() if args.load_and_exit: import os # Disabling device watchdog, so it doesn't need the host to ping periodically. # Note: this is done before importing `depthai` os.environ["DEPTHAI_WATCHDOG"] = "0" import depthai as dai def getPipeline(): enable_4k = False # Will downscale 4K -> 1080p pipeline = dai.Pipeline() # Define a source - color camera cam_rgb = pipeline.createColorCamera() cam_rgb.setBoardSocket(dai.CameraBoardSocket.CAM_A) cam_rgb.setInterleaved(False) #cam_rgb.initialControl.setManualFocus(130) if enable_4k: cam_rgb.setResolution(dai.ColorCameraProperties.SensorResolution.THE_4_K) cam_rgb.setIspScale(1, 2) else: cam_rgb.setResolution(dai.ColorCameraProperties.SensorResolution.THE_1080_P) # Create an UVC (USB Video Class) output node uvc = pipeline.createUVC() cam_rgb.video.link(uvc.input) # Note: if the pipeline is sent later to device (using startPipeline()), # it is important to pass the device config separately when creating the device config = dai.Device.Config() # config.board.uvc = dai.BoardConfig.UVC() # enable default 1920x1080 NV12 config.board.uvc = dai.BoardConfig.UVC(1920, 1080) config.board.uvc.frameType = dai.ImgFrame.Type.NV12 # config.board.uvc.cameraName = "My Custom Cam" pipeline.setBoardConfig(config.board) return pipeline # Will flash the bootloader if no pipeline is provided as argument def flash(pipeline=None): (f, bl) = dai.DeviceBootloader.getFirstAvailableDevice() bootloader = dai.DeviceBootloader(bl, True) # Create a progress callback lambda progress = lambda p : print(f'Flashing progress: {p*100:.1f}%') startTime = time.monotonic() if pipeline is None: print("Flashing bootloader...") bootloader.flashBootloader(progress) else: print("Flashing application pipeline...") bootloader.flash(progress, pipeline) elapsedTime = round(time.monotonic() - startTime, 2) print("Done in", elapsedTime, "seconds") if args.flash_bootloader or args.flash_app: if args.flash_bootloader: flash() if args.flash_app: flash(getPipeline()) print("Flashing successful. Please power-cycle the device") quit() if args.load_and_exit: device = dai.Device(getPipeline()) print("\nDevice started. Attempting to force-terminate this process...") print("Open an UVC viewer to check the camera stream.") print("To reconnect with depthai, a device power-cycle may be required in some cases") # We do not want the device to be closed, so terminate the process uncleanly. # (TODO add depthai API to be able to cleanly exit without closing device) import signal os.kill(os.getpid(), signal.SIGTERM) # Standard UVC load with depthai with dai.Device(getPipeline()) as device: print("\nDevice started, please keep this process running") print("and open an UVC viewer to check the camera stream.") print("\nTo close: Ctrl+C") # Doing nothing here, just keeping the host feeding the watchdog while True: try: time.sleep(0.1) except KeyboardInterrupt: break ``` ## Pipeline ### examples/uvc_rgb.pipeline.json ```json { "pipeline": { "connections": [ { "node1Id": 0, "node1Output": "video", "node1OutputGroup": "", "node2Id": 1, "node2Input": "in", "node2InputGroup": "" } ], "globalProperties": { "calibData": null, "cameraTuningBlobSize": null, "cameraTuningBlobUri": "", "leonCssFrequencyHz": 700000000.0, "leonMssFrequencyHz": 700000000.0, "pipelineName": null, "pipelineVersion": null, "sippBufferSize": 18432, "sippDmaBufferSize": 16384, "xlinkChunkSize": -1 }, "nodes": [ [ 0, { "id": 0, "ioInfo": [ [ [ "", "inputConfig" ], { "blocking": false, "group": "", "id": 1, "name": "inputConfig", "queueSize": 8, "type": 3, "waitForMessage": false } ], [ [ "", "raw" ], { "blocking": false, "group": "", "id": 6, "name": "raw", "queueSize": 8, "type": 0, "waitForMessage": false } ], [ [ "", "still" ], { "blocking": false, "group": "", "id": 7, "name": "still", "queueSize": 8, "type": 0, "waitForMessage": false } ], [ [ "", "inputControl" ], { "blocking": true, "group": "", "id": 2, "name": "inputControl", "queueSize": 8, "type": 3, "waitForMessage": false } ], [ [ "", "video" ], { "blocking": false, "group": "", "id": 3, "name": "video", "queueSize": 8, "type": 0, "waitForMessage": false } ], [ [ "", "isp" ], { "blocking": false, "group": "", "id": 4, "name": "isp", "queueSize": 8, "type": 0, "waitForMessage": false } ], [ [ "", "preview" ], { "blocking": false, "group": "", "id": 5, "name": "preview", "queueSize": 8, "type": 0, "waitForMessage": false } ], [ [ "", "frameEvent" ], { "blocking": false, "group": "", "id": 8, "name": "frameEvent", "queueSize": 8, "type": 0, "waitForMessage": false } ] ], "name": "ColorCamera", "properties": { "boardSocket": 0, "cameraName": "", "colorOrder": 0, "fp16": false, "fps": 30.0, "imageOrientation": -1, "initialControl": { "aeLockMode": false, "aeMaxExposureTimeUs": 0, "aeRegion": { "height": 0, "priority": 0, "width": 0, "x": 0, "y": 0 }, "afRegion": { "height": 0, "priority": 0, "width": 0, "x": 0, "y": 0 }, "antiBandingMode": 0, "autoFocusMode": 3, "awbLockMode": false, "awbMode": 0, "brightness": 0, "captureIntent": 0, "chromaDenoise": 0, "cmdMask": 0, "contrast": 0, "controlMode": 0, "effectMode": 0, "expCompensation": 0, "expManual": { "exposureTimeUs": 0, "frameDurationUs": 0, "sensitivityIso": 0 }, "frameSyncMode": 0, "lensPosAutoInfinity": 0, "lensPosAutoMacro": 0, "lensPosition": 0, "lensPositionRaw": 0.0, "lowPowerNumFramesBurst": 0, "lowPowerNumFramesDiscard": 0, "lumaDenoise": 0, "saturation": 0, "sceneMode": 0, "sharpness": 0, "strobeConfig": { "activeLevel": 0, "enable": 0, "gpioNumber": 0 }, "strobeTimings": { "durationUs": 0, "exposureBeginOffsetUs": 0, "exposureEndOffsetUs": 0 }, "wbColorTemp": 0 }, "interleaved": false, "isp3aFps": 0, "ispScale": { "horizDenominator": 0, "horizNumerator": 0, "vertDenominator": 0, "vertNumerator": 0 }, "numFramesPoolIsp": 3, "numFramesPoolPreview": 4, "numFramesPoolRaw": 3, "numFramesPoolStill": 4, "numFramesPoolVideo": 4, "previewHeight": 300, "previewKeepAspectRatio": true, "previewWidth": 300, "rawPacked": null, "resolution": 0, "sensorCropX": -1.0, "sensorCropY": -1.0, "stillHeight": -1, "stillWidth": -1, "videoHeight": -1, "videoWidth": -1 } } ], [ 1, { "id": 1, "ioInfo": [ [ [ "", "in" ], { "blocking": true, "group": "", "id": 9, "name": "in", "queueSize": 8, "type": 3, "waitForMessage": true } ] ], "name": "UVC", "properties": { "gpioInit": [], "gpioStreamOff": [], "gpioStreamOn": [] } } ] ] } } ``` ### Need assistance? Head over to [Discussion Forum](https://discuss.luxonis.com/) for technical support or any other questions you might have.