Update extending.md #30

lbegani · 2018-08-13T04:26:19Z

Add details on plugins for camera device

hamishwillee · 2018-08-16T11:49:00Z

en/guide/extending.md

@@ -15,39 +15,35 @@ Video Streaming | Developers can implement new types of video streaming (e.g. HL

 ## Support Custom Camera Device

-In order to support a new type of camera a custom class must be derived from `CameraDevice`. In addition, code must be added to detect the new device type and to instantiate the new custom camera device when this happens. The sections below detail these steps.
+Developers may want to add support for a new type of camera device that is not currently supported by DCM. To support a custom type of camera, a `PluginXXX` class derived from `PluginBase` and `CameraDeviceXXX` class derived from `CameraDevice` must be implemented. An example of a plugin for a custom camera device with classes `PluginCustom`(https://github.com/Dronecode/camera-manger/tree/master/plugins) and `CameraDeviceCustom`(https://github.com/Dronecode/camera-manger/tree/master/plugins) is added in the project and may be referenced.


The source code links below don't work (I get 404 so possibly secured).

Fixed Typo. Need to be replaced by this - https://github.com/Dronecode/camera-manager/tree/master/plugins/CustomCamera

hamishwillee · 2018-08-16T11:52:12Z

en/guide/extending.md


-### 1. Extend CameraDevice Class
+### 1. Extend PluginBase Class


Unless this must be done in order, don't have titles numbered.

hamishwillee · 2018-08-16T11:52:46Z

en/guide/extending.md

-To add support for new type of camera device in DCM, a custom class must be derived from `CameraDevice`. 
-An example `CameraDeviceCustom` (in green) can be seen in the [class diagram](../guide/architecture.md#class_diagram). 
-The class `CameraDeviceCustom` represents a custom type of camera device.
+Plugins are self-registering objects that discovers, enlists and creates camera devices.


that discover, list and, ...

hamishwillee · 2018-08-16T11:53:35Z

en/guide/extending.md

-The class `CameraDeviceCustom` represents a custom type of camera device.
+Plugins are self-registering objects that discovers, enlists and creates camera devices.
+
+**Action**: `PluginCustom` must implement the pure virtual functions of the base class `PluginBase`.


I'm not sure we need to have these "Action" headings. It might also be worth having the functions that must be implemented listed here.

hamishwillee · 2018-08-16T11:54:00Z

en/guide/extending.md

-    int setParam(CameraParameters &camParam, std::string param, const char *param_value,
-                 size_t value_size, int param_type);
-```
+There are few methods in `CameraDevice` class that are not pure virtual. By default it returns `NOT_SUPPORTED`.


By default they return NOT_SUPPORTED.

hamishwillee · 2018-08-16T11:54:48Z

en/guide/extending.md


-**Action**: `CameraDeviceCustom` may overload other methods to provide the functionality.
+**Action**: `CameraDeviceCustom` may overload not-pure virtual methods to provide the functionality.


Actually, can't it overload any methods it likes ? Both pure and impure?

hamishwillee · 2018-08-16T11:55:33Z

en/guide/extending.md


-**Action**: `CameraDeviceCustom` may overload other methods to provide the functionality.
+**Action**: `CameraDeviceCustom` may overload not-pure virtual methods to provide the functionality.

 The configurable parameters of the custom camera device can be exported to the client (GCS) for control. Setting of these parameters and resetting of all the parameters must be handled by the `CameraDeviceCustom` class.

 **Action*: `CameraDeviceCustom` must declare the parameter name (string), ID (int) and type (enum). Also set the default value of the parameter.


Again, not sure that we really need the "Action" headings. But if you want to keep them, this one has a missing asterisk.

So maybe something like

CameraDeviceCustom may declare the parameters that are relevant to the camera type. Each parameter has a name (string), ID (int), type (enum) and default value.

What about the case where a camera can have unique parameters? ie it implements some generic API, but might have additional parameters that aren't part of the API itself (ie that might be set by camera config file).
I guess what I'm saying is what parameters get set here, and which get set in a camera definition file?

hamishwillee · 2018-08-16T12:02:11Z

en/guide/extending.md

-    } else if (camdev_name.find("camera/custom") != std::string::npos) {
-        return std::make_shared<CameraDeviceCustom>(camdev_name);
-```
+The `CameraServer` will query the `PluginManager` for the list of camera devices that are detected. `CameraServer` will create the `CameraDevice` if the device is not in the blacklist.


maybe link to blacklist docs?

hamishwillee · 2018-08-16T12:03:29Z

@lbegani Looks like a good start, but links to custom plugin don't work, so not sure how much can be inferred from source. I'd be tempted to list the methods that need to be overloaded - we were going to document these in source right?

lbegani · 2018-08-16T12:06:08Z

@hamishwillee I will fix the comments soon. I have documented the public APIs in the sources - https://github.com/Dronecode/camera-manager/blob/master/src/PluginBase.h
https://github.com/Dronecode/camera-manager/blob/master/src/CameraDevice.h

hamishwillee · 2018-08-16T12:13:08Z

OK, probably if you link to the base classes that doc will help people understand what is going on! Great.

hamishwillee · 2018-08-16T13:15:43Z

@lbegani I have created some experimental API ref here.

Do you think having this in the documentation is useful?
Is this the public API that we need documented? If not, what other classes do you think need to be included - parameters? Should anything be removed?
As you can see there is a lot that is NOT documented there. It is good to provide comments for as much as possible. Some of this is because we haven't tagged comments as @brief - this is a good way to highlight the short description for an element - e.g this has a description http://localhost:4000/en/plugin_ref/struct_camera_data.html#struct_camera_info_1a23844d6d1740e872be7a06eb5884f98d - if you tag it as @brief then the description will also appear up the top.

Update extending.md

0f83754

Add details on plugins for camera device

lbegani requested a review from hamishwillee August 13, 2018 04:26

hamishwillee reviewed Aug 16, 2018

View reviewed changes

Update extending.md

187e015

hamishwillee reviewed Aug 16, 2018

View reviewed changes

mrpollo force-pushed the master branch 4 times, most recently from fc20582 to 3af8220 Compare April 29, 2020 05:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update extending.md #30

Update extending.md #30

lbegani commented Aug 13, 2018

hamishwillee Aug 16, 2018

lbegani Aug 16, 2018 •

edited

hamishwillee Aug 16, 2018

hamishwillee Aug 16, 2018

hamishwillee Aug 16, 2018

hamishwillee Aug 16, 2018

hamishwillee Aug 16, 2018

hamishwillee Aug 16, 2018

hamishwillee Aug 16, 2018

hamishwillee Aug 16, 2018

hamishwillee commented Aug 16, 2018

lbegani commented Aug 16, 2018 •

edited

hamishwillee commented Aug 16, 2018

hamishwillee commented Aug 16, 2018 •

edited


		### 1. Extend CameraDevice Class
		### 1. Extend PluginBase Class


		Action: `CameraDeviceCustom` may overload other methods to provide the functionality.
		Action: `CameraDeviceCustom` may overload not-pure virtual methods to provide the functionality.

Update extending.md #30

Are you sure you want to change the base?

Update extending.md #30

Conversation

lbegani commented Aug 13, 2018

Choose a reason for hiding this comment

lbegani Aug 16, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hamishwillee commented Aug 16, 2018

lbegani commented Aug 16, 2018 • edited

hamishwillee commented Aug 16, 2018

hamishwillee commented Aug 16, 2018 • edited

lbegani Aug 16, 2018 •

edited

lbegani commented Aug 16, 2018 •

edited

hamishwillee commented Aug 16, 2018 •

edited