288: You Got a Screen!
Embedded10 Touko 2019

288: You Got a Screen!

Christopher (@stoneymonster) and Elecia (@logicalelegance) discuss embedded systems education and project documentation.

Elecia wrote about her love of notebooks on the https://www.embedded.fm/blog-index.

yEd, for when you don't have Visio. Asciiflow.com, for when you don't have yEd (or you want to put diagrams in your comments)

We talked about many different documents and tried to note design vs implementation, product vs engineering vs user, and why we wanted them. We didn't mention mechanical things because, ya know, software engineers. Some documentation we mentioned:

  • Product documentation

  • Schematics with block diagrams and comments. Also a GPIO to function spreadsheet.

  • UI flow when the system has a screens (Balsamiq for wireframe testing UIs)

  • SW spec and design doc: what do we plan to build and what are the tricky parts

  • SW configuration and SW developer docs: how to rebuild the computer that can build the code from scratch, also notes on debugging methodology

  • User manual: Usually not written by SW but may need SW's patient input

  • Code comments: Functions and files get 5Ws: who, what, why, when, where, and how.

    • Who should call this?

    • What will its effect be? ("What will it do" but not in line by line detail!)

    • How does it work?

    • Why does it work this way?

    • When should it be called?

    • Where are its parameters? ("What" works here too but "where" is nice to remind you to check your memory assumptions.)

  • Repository checkin comments

  • Style guide (Such as Google's or PEP)

  • Manufacturing docs and tests docs

Adafruit and Sparkfun both write good documentation, writing to users about how to use their code. Elecia likes Adafruit's sensor library as a good set of code to review (including how much is in their docs vs their code).

Jaksot(567)

480: Surprises Early In The Game

480: Surprises Early In The Game

Jerry Twomey spoke with us about his new O'Reilly book Applied Embedded Electronics which covers embedded topics such as EMI, signal processing, control systems and non-ideal components. Jerry is also...

27 Kesä 20241h 1min

479: Make Your Voice Heard

479: Make Your Voice Heard

Carles Cufí spoke with us about Zephyr, Nordic, learning, open source development, and corporate goals. Carles had some great suggestions for learning Zephyr: Memfault Interrupt Practical Zephyr bl...

13 Kesä 20241h 5min

478: The Map Is Not the Territory

478: The Map Is Not the Territory

Jan Rychter joined us to talk about building a company, electronic components, and software design. Jan is the founder and engineer at PartsBox.com. If you are interested in the meta-analysis of the d...

30 Touko 202455min

477: One Thousand New Instructions

477: One Thousand New Instructions

Kwabena Agyeman joined Chris and Elecia to talk about optimization, cameras, machine learning, and vision systems. Kwabena is the head of OpenMV (openmv.io), an open source and open hardware system t...

16 Touko 20241h 24min

476: Sidetracked by Mining the Moon

476: Sidetracked by Mining the Moon

Lee Wilkins joined Chris and Elecia to talk about The Open Source Hardware Association, the Open Hardware Summit, and zine culture. The Open Source Hardware Association (OSHWA) provides certification ...

1 Touko 202456min

475: Stuffed Animal or Colleague

475: Stuffed Animal or Colleague

Chris and Elecia talk about the Embedded Online Conference, their experience learning Zephyr, and some listener questions. Elecia will be presenting on Creating Chaos and Hard Faults at the Embedded ...

19 Huhti 20241h 9min

474: It's All Chaos and Horror

474: It's All Chaos and Horror

Logic gates and origami? Professor Inna Zakharevich joined us to talk about Turing complete origami crease patterns. We started talking about Turing completeness which led to a Conway's Game of Life-...

5 Huhti 20241h 11min

473: Math Is Not the Answer

473: Math Is Not the Answer

Philip Koopman joined us to talk about how modulo 255 vs 256 makes a huge difference in checksum error detection, how to get the most out of your checksum or CRC, and why understanding how they work i...

21 Maalis 20241h 10min

Suosittua kategoriassa Tiede

rss-mita-tulisi-tietaa
tiedekulma-podcast
rss-poliisin-mieli
docemilia
rss-duodecim-lehti
utelias-mieli
filocast-filosofian-perusteet
rss-laakaripodi
rss-opeklubi
rss-lihavuudesta-podcast
rss-sosiopodi
sotataidon-ytimessa
mielipaivakirja
radio-antro
rss-radplus
rss-luontopodi-samuel-glassar-tutkii-luonnon-ihmeita