proposed changes to serial config and usage docs, closes #141

firmata / firmata.js

JavaScript implementation of the Firmata protocol

711 stars 147 forks source link

proposed changes to serial config and usage docs, closes #141 #142

Closed jywarren closed 7 years ago

jywarren commented 7 years ago

Not sure of your preferences, but tried to balance parse-able JSON in the example with clear/thorough commenting. But this meant each comment needed to be shorter to not wrap or get cut off on narrower screens.

I think this makes firmata.js easier to use for newcomers; open to suggestions and many thanks!

soundanalogous commented 7 years ago

There's actually a lot of important documentation missing here:

HW_SERIAL0 cannot be used
when using SW_SERIALn, baud rate can not be > 57600

There are actually several SW_SERIAL cavaets that need to be documented, but I'll need to add those since I'm probably the only person who understands what they are... too much in my head... not enough on paper doh!

jywarren commented 7 years ago

OK, I'm updating this PR in any case, but happy to add more if you've got it written out -- or I could just add those two bullet points...