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

doc: release: Add Zephyr 3.6 highlights #68994

Merged

Conversation

kartben
Copy link
Collaborator

@kartben kartben commented Feb 14, 2024

Taking a first stab at adding a high-level summary of the most notable highlights of Zephyr 3.6.

Maybe we can use this PR as a way to discuss & converge towards the final list, esp. as more release notes keep coming in (pretty sure -and hopeful!- there should be at least one entry related to Bluetooth in there)?
WDYT @henrikbrixandersen @MaureenHelm & others?

Edit: "as more release notes keep coming in "... and as I make progress on the announcement blog post, as I'm sure I will be spotting more, that at least to me will be worth highlighting :)

@kartben kartben force-pushed the zephyr_3.6_release_highlights branch from 2731a9d to 76da46a Compare February 14, 2024 16:45
@kartben kartben changed the title releases: Add Zephyr 3.6 highlights doc: release: Add Zephyr 3.6 highlights Feb 14, 2024
Copy link
Member

@henrikbrixandersen henrikbrixandersen left a comment

Choose a reason for hiding this comment

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

This is a great start, thanks! Perhaps we could add links to the relevant documentation for each entry?

@kartben
Copy link
Collaborator Author

kartben commented Feb 14, 2024

This is a great start, thanks! Perhaps we could add links to the relevant documentation for each entry?

Yes I was thinking the same, we should certainly do that for sure. And if an item doesn't have a "good enough" link for us to use, now would probably be a good time to make sure there is one, as we want the highlights to be things people can easily learn more about.

@bjarki-andreasen
Copy link
Collaborator

Love it! I am working on a section in the release notes for GNSS as well :)

@kartben
Copy link
Collaborator Author

kartben commented Feb 14, 2024

Love it! I am working on a section in the release notes for GNSS as well :)

Eheh, excellent! If you're bored, I would love to have a demo of cellular + gnss + lvgl, i.e. get GPS coordinates, compute the corresponding openstreetmap tile URL, fetch it and display it on the screen :)
I will try to get to it but I might simply run out of time. Should literally be just about 50 lines of code I'm sure, and would be VERY COOL (and a great sample/demo to actually add upstream...). Bonus points if we hook up some of @fabiobaltieri's input magic to zoom in / zoom out when pressing key on a keyboard :-)

@fabiobaltieri
Copy link
Member

fabiobaltieri commented Feb 14, 2024

@kartben wanna mention something about the keyboard matrix driver? It's just a driver in a sea of drivers but it'd be nice to mention since it it does not depend on anything in particular and could be used with any platform we support. (but also happy with not mentioning on the basis of: it's just a driver)

@kartben
Copy link
Collaborator Author

kartben commented Feb 14, 2024

@kartben wanna mention something about the keyboard matrix driver? It's just a driver in a sea of drivers but it'd be nice to mention since it it does not depend on anything in particular and could be used with any platform we support. (but also happy with not mentioning on the basis of: it's just a driver)

Just read again :-) Guess the wording of that particular bullet item might be backwards or something, hence why you maybe missed it. Please suggest a better wording if you can think of one!
And yes, "just" a driver but worth calling out imo

@bjarki-andreasen
Copy link
Collaborator

@kartben I'm game helping you make the sample work!

@fabiobaltieri
Copy link
Member

@kartben sorry somehow I missed it :-) plenty good thanks for the mention

@henrikbrixandersen henrikbrixandersen added this to the v3.6.0 milestone Feb 14, 2024
@kartben kartben added the DNM This PR should not be merged (Do Not Merge) label Feb 14, 2024
@kartben kartben force-pushed the zephyr_3.6_release_highlights branch from 76da46a to 768e665 Compare February 14, 2024 21:00
@MaureenHelm
Copy link
Member

This is a great start, thanks! Perhaps we could add links to the relevant documentation for each entry?

Yes I was thinking the same, we should certainly do that for sure. And if an item doesn't have a "good enough" link for us to use, now would probably be a good time to make sure there is one, as we want the highlights to be things people can easily learn more about.

This is great, thanks @kartben . Like the idea to add docs links.

Should add a bullet about #60063. @yperess @teburd

@yperess
Copy link
Collaborator

yperess commented Feb 14, 2024

This is a great start, thanks! Perhaps we could add links to the relevant documentation for each entry?

Yes I was thinking the same, we should certainly do that for sure. And if an item doesn't have a "good enough" link for us to use, now would probably be a good time to make sure there is one, as we want the highlights to be things people can easily learn more about.

This is great, thanks @kartben . Like the idea to add docs links.

Should add a bullet about #60063. @yperess @teburd

I think it's worth a mention, I can write something up tonight if that helps and post it here as a comment.

@kartben
Copy link
Collaborator Author

kartben commented Feb 14, 2024

I think it's worth a mention, I can write something up tonight if that helps and post it here as a comment.

That would be very helpful yes, and yes I agree it's totally worth mentioning. One challenge though is that it doesn't look like we would have something (think: doc page or code sample) to point people to?

If you are to write something tonight, I'd rather this would be some blurb to maybe add to the sensor shell sample explaining how one may play with the streaming API, as this would make a huge difference in the "discoverability" of this feature, including for all the folks who might not even read the release notes and could easily miss it for it's not really documented (i.e searching "streaming" gives virtually no result)
Thanks!

@yperess
Copy link
Collaborator

yperess commented Feb 15, 2024

I think it's worth a mention, I can write something up tonight if that helps and post it here as a comment.

That would be very helpful yes, and yes I agree it's totally worth mentioning. One challenge though is that it doesn't look like we would have something (think: doc page or code sample) to point people to?

If you are to write something tonight, I'd rather this would be some blurb to maybe add to the sensor shell sample explaining how one may play with the streaming API, as this would make a huge difference in the "discoverability" of this feature, including for all the folks who might not even read the release notes and could easily miss it for it's not really documented (i.e searching "streaming" gives virtually no result)
Thanks!

We were going to hold off on the docs until we had better rtio support which @teburd is currently working on. So we'll probably have a big pay for documenting and advertising going into 3.7

@yperess
Copy link
Collaborator

yperess commented Feb 15, 2024

@kartben sorry for the delay, @teburd any changes that you'd like to make?

Introduced a new async sensor API that's 100% backwards compatible with the previous fetch/get blocking calls. It is
possible to enable the API via the CONFIG_SENSOR_ASYNC_API. This API should work on any sensor driver that exists
in Zephyr currently. On-top of this API, an additional streaming API was added. When enabled, the API works similarly
to the trigger API but provides a user thread safe way to get the data. Additionally, the streaming API provides 3
different ways to handle the trigger:

  1. include - where the data produced by the sensor is included with the completion queue entry
  2. nop - only notify the completion queue of the event, but do nothing with the data
  3. drop - notify the completion queue of the event, and clear out the data (example: FIFO flush)

Related APIs: RTIO

@teburd
Copy link
Collaborator

teburd commented Feb 15, 2024

I think it's worth a mention, I can write something up tonight if that helps and post it here as a comment.

That would be very helpful yes, and yes I agree it's totally worth mentioning. One challenge though is that it doesn't look like we would have something (think: doc page or code sample) to point people to?
If you are to write something tonight, I'd rather this would be some blurb to maybe add to the sensor shell sample explaining how one may play with the streaming API, as this would make a huge difference in the "discoverability" of this feature, including for all the folks who might not even read the release notes and could easily miss it for it's not really documented (i.e searching "streaming" gives virtually no result)
Thanks!

We were going to hold off on the docs until we had better rtio support which @teburd is currently working on. So we'll probably have a big pay for documenting and advertising going into 3.7

I agree this is the time frame when I'd really like to showcase and advertise these things more. The problem today with advertising this stuff is no one can use it yet, as its basically only supported on one board on one soc. That's exactly what I'm looking to improve on in the 3.7 timeframe. Ultimately having an open source user (e.g. cognipilot with @bperseghetti) will also help tremendously build up the case for it.

It's been experimental, still is experimental, and needs to expand and be proven out maybe one more release cycle before the big tada moment.

@kartben
Copy link
Collaborator Author

kartben commented Feb 15, 2024

It's been experimental, still is experimental, and needs to expand and be proven out maybe one more release cycle before the big tada moment.

Absolutely fine by me! So we might not need more than the "Added new streaming APIs and implemented in the ICM42688 driver." bullet point that's already in the release notes then.

@aescolar
Copy link
Member

(pretty sure -and hopeful!- there should be at least one entry related to Bluetooth in there)?

@jori-nordic @jhedberg @Thalley @cvinayak @PavelVPV ^^
Anything BT related we should add to the highlights section of the release notes?

@Thalley
Copy link
Collaborator

Thalley commented Feb 20, 2024

(pretty sure -and hopeful!- there should be at least one entry related to Bluetooth in there)?

@jori-nordic @jhedberg @Thalley @cvinayak @PavelVPV ^^ Anything BT related we should add to the highlights section of the release notes?

I don't have anything specific

@PavelVPV
Copy link
Collaborator

PavelVPV commented Feb 20, 2024

(pretty sure -and hopeful!- there should be at least one entry related to Bluetooth in there)?

@jori-nordic @jhedberg @Thalley @cvinayak @PavelVPV ^^ Anything BT related we should add to the highlights section of the release notes?

Could this line go into highlights?

* The Bluetooth Mesh Protocol 1.1 is now supported by default.

@kartben kartben force-pushed the zephyr_3.6_release_highlights branch from 768e665 to ea0b649 Compare February 20, 2024 19:30
@kartben
Copy link
Collaborator Author

kartben commented Feb 20, 2024

(pretty sure -and hopeful!- there should be at least one entry related to Bluetooth in there)?

@jori-nordic @jhedberg @Thalley @cvinayak @PavelVPV ^^ Anything BT related we should add to the highlights section of the release notes?

Could this line go into highlights?

* The Bluetooth Mesh Protocol 1.1 is now supported by default.

added in the latest push

@jori-nordic
Copy link
Collaborator

@aescolar should we mention the UART you made + the fact that HCI H4 sample + driver combo is now tested in CI?
Maybe not in the highlights, but I definitely think it warrants a mention somewhere. A lot of people depend on it and it was previously not tested at all.

@aescolar
Copy link
Member

@aescolar should we mention the UART you made + the fact that HCI H4 sample + driver combo is now tested in CI?

Thanks @jori-nordic . It is mentioned at the end on the testing & samples section

@kartben kartben marked this pull request as ready for review February 21, 2024 15:36
MaureenHelm
MaureenHelm previously approved these changes Feb 21, 2024
aescolar
aescolar previously approved these changes Feb 21, 2024
@henrikbrixandersen
Copy link
Member

@kartben Can we please remove the DNM label and get this merged so we can finalize the release notes?

@kartben kartben removed the DNM This PR should not be merged (Do Not Merge) label Feb 22, 2024
This adds a high-level summary of the most notable highlights of
Zephyr 3.6.

Signed-off-by: Benjamin Cabé <[email protected]>
@kartben
Copy link
Collaborator Author

kartben commented Feb 22, 2024

@kartben Can we please remove the DNM label and get this merged so we can finalize the release notes?

yes! Added LTO and fixed the issues pointed by @fabiobaltieri

@MaureenHelm MaureenHelm merged commit f31b527 into zephyrproject-rtos:main Feb 22, 2024
13 checks passed
@kartben kartben deleted the zephyr_3.6_release_highlights branch March 18, 2024 21:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Release Notes To be mentioned in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.