Skip to content

Improvements to custom library + oot driver class + documentation #61

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 13 commits into from
Apr 9, 2024
Merged

Improvements to custom library + oot driver class + documentation #61

merged 13 commits into from
Apr 9, 2024

Conversation

gmarull
Copy link
Member

@gmarull gmarull commented Apr 3, 2024

No description provided.

@gmarull
include: namespace includes with app/ prefix
2da9bf4 
All example-application level includes will have the 'app' prefix,
making ownership obvious and reducing the chances of namespacing
clashes. This aligns with how Zephyr works with the 'zephyr' prefix.

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
@gmarull gmarull force-pushed the misc-improvements branch 3 times, most recently from 919f1a6 to 2cb37c6 Compare April 3, 2024 13:49
@gmarull gmarull changed the title Improvements to custom library Improvements to custom library + documentation Apr 3, 2024
fabiobaltieri
fabiobaltieri reviewed Apr 3, 2024
View reviewed changes
@gmarull gmarull force-pushed the misc-improvements branch 3 times, most recently from 695c260 to 3cb3ac9 Compare April 3, 2024 14:22
@gmarull gmarull requested review from kartben and fabiobaltieri April 3, 2024 14:25
@gmarull gmarull force-pushed the misc-improvements branch from 3cb3ac9 to 998c6b3 Compare April 4, 2024 12:15
fabiobaltieri
fabiobaltieri reviewed Apr 4, 2024
View reviewed changes
@gmarull gmarull force-pushed the misc-improvements branch from 998c6b3 to 654c18a Compare April 4, 2024 13:02
@gmarull gmarull force-pushed the misc-improvements branch from 654c18a to f95b41e Compare April 5, 2024 09:16
@gmarull
Copy link
Member Author

gmarull commented Apr 5, 2024

last push: fixed typo in readme

@fabiobaltieri
Copy link
Member

@kartben can you take a look as well?

@carlescufi
Copy link
Member

carlescufi commented Apr 5, 2024 •
edited
Loading

Artifact can be downloaded for now, and it looks like:

image image

@wbober
Copy link
Member

wbober commented Apr 5, 2024 •
edited
Loading

@gmarull Can we put a section with the doxygen API from the sphinx docs please?

@gmarull
Copy link
Member Author

gmarull commented Apr 5, 2024

@gmarull Can we put a section with the doxygen API from the sphinx docs please?

I'm skeptical on that, since breathe, the extension to do that is de-facto unmaintained (and has well-known issues like scalability problems)

gmarull added 5 commits April 8, 2024 13:55
@gmarull
lib: custom: simplify naming scheme
3ca6216 
Improve the naming scheme of the custom library.

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
@gmarull
boards: custom_plank: tweak defconfig with UART console
88907b0 
To improve the default user experience. However, explain this may not be
the best choice on production boards.

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
@gmarull
drivers: sensor: s/examplesensor/example-|_sensor/
d76cbbe 
Just a rename so things look a bit nicer.

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
@gmarull
drivers: blink: add custom out-of-tree driver class
1fa0352 
Add a new out-of-tree custom driver class to demonstrate all aspects of
custom driver class creation.

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
@gmarull
drivers: blink: blink-gpio-led: add initial implementation
1331685 
Add a blink driver implementation for a GPIO-controlled LED.

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
@gmarull gmarull force-pushed the misc-improvements branch from f95b41e to fdd73dd Compare April 8, 2024 12:03
@gmarull gmarull changed the title Improvements to custom library + documentation Improvements to custom library + oot driver class + documentation Apr 8, 2024
@gmarull
Copy link
Member Author

gmarull commented Apr 8, 2024

last push: some tweaks, plus added a custom driver class. All can be run on nrf52840dk (using custom_plank target) and nucleo_f302r8 boards.

gmarull added 7 commits April 8, 2024 14:05
@gmarull
boards: custom_plank: instantiate blink-gpio-led
8e290fd 
Define an instance of a blink-gpio-led. Since custom_plank is in reality
a nRF52840DK, this uses LED0 as the blink-gpio-led.

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
@gmarull
app: boards: nucleo_f302r8: instantiate blink-gpio-led
b7046ad 
Instantiate blink-gpio-led (uses board Green LED).

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
@gmarull
app: update application to use the custom blink API
ea8cb9a 
Update the application to use the new custom blink API. It changes the
blink period if the sensor reports a proximity value that is 1.

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
@gmarull
doc: add Doxygen configuration
34778ea 
Add a simple Doxygen configuration that allows to build documentation
for the application APIs found under include/.

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
@gmarull
doc: add minimal Sphinx setup
1ee4e00 
Add a minimal Sphinx-based setup, also configuring intersphinx for
Zephyr.

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
@gmarull
ci: add workflow to build and publish docs
d1826b2 
Add a workflow that, for now, builds Doxygen docs and published them on
Github pages.

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
@gmarull
readme: add documentation details
31518ae 
Inform the users on how to quickly build the documentation.

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
@gmarull gmarull force-pushed the misc-improvements branch from fdd73dd to 31518ae Compare April 8, 2024 12:06
@carlescufi
Copy link
Member

Talked to @kartben, agreed to move on with it.

@carlescufi carlescufi merged commit 71c249b into zephyrproject-rtos:main Apr 9, 2024
6 checks passed
@gmarull gmarull deleted the misc-improvements branch April 9, 2024 12:06
@fabiobaltieri
Copy link
Member

This now publishes at https://zephyrproject-rtos.github.io/example-application/sphinx/ and https://zephyrproject-rtos.github.io/example-application/doxygen/, @gmarull you may want to add a static index for https://zephyrproject-rtos.github.io/example-application

@gmarull
Copy link
Member Author

gmarull commented Apr 11, 2024

This now publishes at https://zephyrproject-rtos.github.io/example-application/sphinx/ and https://zephyrproject-rtos.github.io/example-application/doxygen/, @gmarull you may want to add a static index for https://zephyrproject-rtos.github.io/example-application

sphinx is now the root doc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fabiobaltieri fabiobaltieri fabiobaltieri approved these changes

@carlescufi carlescufi carlescufi approved these changes

@kartben kartben Awaiting requested review from kartben

@stephanosio stephanosio Awaiting requested review from stephanosio

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@gmarull @fabiobaltieri @carlescufi @wbober @stephanosio