Skip to content

Commit b314fa2

Browse files
authored
Merge pull request #738 from luxonis/docs_update
Updated Bootloader and VideoEncoder docs, added TCP/MQTT comms to Scr…
2 parents f2a55d8 + cf3297c commit b314fa2

File tree

3 files changed

+15
-5
lines changed

3 files changed

+15
-5
lines changed

docs/source/components/bootloader.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,4 +102,11 @@ Depthai application package (**.dap**) consists of:
102102
- Assets structure (section “assets”)
103103
- Asset storage (section “asset_storage”)
104104

105+
MAC address
106+
###########
107+
108+
All OAK PoE cameras have a unique MAC address which is used to identify the device on the network. It is calculated from the
109+
MxID of the device, see `logic here <https://gist.github.com/Erol444/85d6ef7ae9c946f5688854b86c548dc7>`__.
110+
The MAC address is stored in the DeviceBootloader configuration.
111+
105112
.. include:: ../includes/footer-short.rst

docs/source/components/nodes/script.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,8 @@ Examples of functionality
217217
- :ref:`Script camera control` - Controlling the camera
218218
- :ref:`Script get local IP` - Get local IP
219219
- :ref:`Script HTTP client` - Send HTTP request
220+
- `Script TCP streaming <https://github.com/luxonis/depthai-experiments/tree/master/gen2-poe-tcp-streaming>`__ - TCP communication from within Script node, either in host or client mode
221+
- `Script MQTT publishing <https://github.com/luxonis/depthai-experiments/tree/master/gen2-poe-mqtt>`__ - MQTT publishing from within Script node
220222
- :ref:`Script HTTP server` - still image over HTTP
221223
- :ref:`Script MJPEG server` - MJPEG video stream over HTTP
222224
- :ref:`Script NNData example` - Constructs :ref:`NNData`

docs/source/components/nodes/video_encoder.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
VideoEncoder
22
============
33

4-
VideoEncoder node is used to encode :ref:`image frames <ImgFrame>` into H264/H265/JPEG.
4+
VideoEncoder node is used to encode :ref:`ImgFrame` into either H264, H265, or MJPEG streams. Only NV12 or GRAY8 (which gets converted to NV12) format is
5+
supported as an input.
56

67
.. include:: /includes/container-encoding.rst
78

@@ -36,7 +37,7 @@ Inputs and Outputs
3637
3738
**Message types**
3839

39-
- :code:`input` - :ref:`ImgFrame`
40+
- :code:`input` - :ref:`ImgFrame` (NV12/GRAY8)
4041
- :code:`bitstream` - :ref:`ImgFrame`
4142

4243
Usage
@@ -55,7 +56,7 @@ Usage
5556

5657
# Create MJPEG encoding for still images
5758
stillEncoder = pipeline.create(dai.node.VideoEncoder)
58-
stillEncoder.setDefaultProfilePreset(cam.getStillSize(), 1, dai.VideoEncoderProperties.Profile.MJPEG)
59+
stillEncoder.setDefaultProfilePreset(1, dai.VideoEncoderProperties.Profile.MJPEG)
5960

6061
cam.still.link(stillEncoder.input)
6162
cam.video.link(videoEncoder.input)
@@ -67,11 +68,11 @@ Usage
6768
// Create ColorCamera beforehand
6869
// Set H265 encoding for the ColorCamera video output
6970
auto videoEncoder = pipeline.create<dai::node::VideoEncoder>();
70-
videoEncoder->setDefaultProfilePreset(cam->getVideoSize(), cam->getFps(), dai::VideoEncoderProperties::Profile::H265_MAIN);
71+
videoEncoder->setDefaultProfilePreset(cam->getFps(), dai::VideoEncoderProperties::Profile::H265_MAIN);
7172

7273
// Create MJPEG encoding for still images
7374
stillEncoder = pipeline.create(dai.node.VideoEncoder);
74-
stillEncoder->setDefaultProfilePreset(cam->getStillSize(), 1, dai::VideoEncoderProperties::Profile::MJPEG);
75+
stillEncoder->setDefaultProfilePreset(1, dai::VideoEncoderProperties::Profile::MJPEG);
7576

7677
cam->still.link(stillEncoder->input);
7778
cam->video.link(videoEncoder->input);

0 commit comments

Comments
 (0)