Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add PARAMETER_DESCRIPTION and a way to define custom parameters #100

Merged
merged 5 commits into from
Sep 23, 2023

Conversation

arneboe
Copy link
Contributor

@arneboe arneboe commented Sep 17, 2023

Note: This PR is build on top of #93. Therefore the commits from #93 are also part of this PR. Only the last commit belongs to this PR

This pull request adds support for the PARAMETER_DESCRIPTION parameter which is required by the spec when the SUPPORTED_PARAMETERS parameter is supported.

In addition it adds the rdm_register_manufacturer_specific_simple() function. This function can be called by the user to add simple parameters. Simple parameters are all parameters that can be handled by rdm_simple_response_cb.
I am not sure if rdm_register_manufacturer_specific_simple() is a good design choice. I added it because I needed a way to test the implementation. An alternative would be to expose rdm_simple_response_cb to the user.

This is the last building block that is missing to support manufacturer specific parameters.
Please let me know what you think about this.

A simple example is provided in RDMManufacturerSpecificParameter.ino.
The example does not contain any documentation because I want to wait for your comments on this PR before documenting. I will add documentation once you are fine with the implementation.

@arneboe arneboe force-pushed the parameter_description branch 5 times, most recently from f4e9039 to ba6cd79 Compare September 17, 2023 16:05
Copy link
Owner

@someweisguy someweisguy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Thank you!

@someweisguy someweisguy merged commit ff0ab49 into someweisguy:release/v3.1 Sep 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants