Firmware Pre-Release Docs for v0.6.0-rc.2


#1

Hey all!

I’m sure many you have been wondering where the Docs are for the recent v0.6.0-rc.1 and v0.6.0-rc.2 firmware release that has been on the Build IDE for a bit now.

We didn’t want to confuse the normal Docs with pre-release firmware features, so we decided to use the Prerelease Docs for pre-release firmware documentation. Once the pre-release firmware becomes a default release, we’ll merge these Prerelease Docs into the regular master Docs (and keep changes to master sync’d to Prerelease).

I’ve gone back and edited this firmware update post for v0.6.0-rc.1, and added Docs links for everything that is currently in Docs. In doing so, I’ve erased the link click count on the number of times many of you clicked on things… most notably were the new Logging API and System Reset Reason which now have docs. Some of the USB HID driver stuff has more info and examples in the original Pull Requests that are also linked in the Changelog, and this is also very much compatible with the Arduino HID mouse and keyboard API. There are some known issues with HID driver support on Windows that have been fixed in v0.6.0-rc.2 which is out now.

If there are things missing that you want more info about, please ask here and we’ll fill in the gaps :smile:


pinned #2

#3

@Bdub The following two links do not bring me to the info about the Logging API or the System Reset Reason function. I tried using the search bar in the new doc staging doc page, but it does not pull up this info either.

Not sure if I’m doing something wrong or if it’s not working as it’s supposed to.

EDIT: I fixed the links above -BDub


#4

Hmm… sorry about that. It was there I swear! It appears not everyone at Particle knew we were using staging for pre-release docs and the changes got blown away.

EDIT: Because staging really needs to be free for experiments and what not, we’ll spin up a separate Prerelease Docs site early next week. For now I’ll edit the links to point to places in this file on Github: https://github.com/spark/docs/blob/prerelease/firmware/firmware.md I know it’s not what you expect for Docs, but at least you can read about the new features while we work on the new site. In general, if you open that file and you search for “0.6.0” you’ll find all of the new docs for 0.6.0-rc.1.


#5

Hey all!

The new prerelease-docs.particle.io site is up and will always reflect the latest prerelease firmware version that is out. Currently that’s 0.6.0-rc.2. When prerelease firmware is committed as a default release such as 0.6.0, we’ll be merging prerelease-docs into docs (master) and until the next prerelease is out they will have to be kept in sync (merging docs master into prerelease).

I’ll be updating the links above to point to the right places at this new site. EDIT: updated!