Adafruit Industries, Essential service and business: NYC – Executive Order 202.6 - Read more. Accepting essential orders - here's how.
0

Paying it Forward: Documenting your Open Hardware #OpenHardware #OpenSOurce @xobs

Sean “xobs” Cross has an excellent discussion from linux.conf.au on documenting Open Hardware modules (undocumented hardware is bad).

We all know documentation is important, but often times it’s seen as either something to be done before a project starts — in which case it’s often outdated — or after the project is complete — at which point it’s easily forgotten. This problem is especially difficult with hardware projects, which can be extremely obscure and dense.

Professional chips generally come with a reference manual that describes the hardware. This manual is usually created by a dedicated staff that uses publishing tools and spreadsheets to create a final PDF file. As small open source developers we rarely have the resources to create these reference manuals by hand.

This talk covers `lxsocdoc`, and covers how they document the various peripherals inside projects such as Fomu and Betrusted, and provide motivation for treating documentation like code. They show why documenting as you go is both beneficial to end users, as well as beneficial to yourself, and why an approach such as the one taken in `lxsocdoc` can help yourself today, not to mention your future self.

See the video here.


Stop breadboarding and soldering – start making immediately! Adafruit’s Circuit Playground is jam-packed with LEDs, sensors, buttons, alligator clip pads and more. Build projects with Circuit Playground in a few minutes with the drag-and-drop MakeCode programming site, learn computer science using the CS Discoveries class on code.org, jump into CircuitPython to learn Python and hardware together, TinyGO, or even use the Arduino IDE. Circuit Playground Express is the newest and best Circuit Playground board, with support for CircuitPython, MakeCode, and Arduino. It has a powerful processor, 10 NeoPixels, mini speaker, InfraRed receive and transmit, two buttons, a switch, 14 alligator clip pads, and lots of sensors: capacitive touch, IR proximity, temperature, light, motion and sound. A whole wide world of electronics and coding is waiting for you, and it fits in the palm of your hand.

Join 16,000+ makers on Adafruit’s Discord channels and be part of the community! http://adafru.it/discord

Have an amazing project to share? The Electronics Show and Tell is every Wednesday at 7:30pm ET! To join, head over to YouTube and check out the show’s live chat – we’ll post the link there.

Join us every Wednesday night at 8pm ET for Ask an Engineer!

Follow Adafruit on Instagram for top secret new products, behinds the scenes and more https://www.instagram.com/adafruit/

CircuitPython – The easiest way to program microcontrollers – CircuitPython.org


Maker Business — 1,000 True Fans, how creators can sustain themselves in the digital age

Wearables — Hobby knife on hand

Electronics — Diode Vf vs Voltage

Biohacking — Vitamin-C + Gelatin for Accelerated Recovery

Python for Microcontrollers — CircuitPython 5.1.0 Released and more! #Python #Adafruit #CircuitPython @circuitpython @micropython @ThePSF @Adafruit

Adafruit IoT Monthly — Together we’ll make it, Upcycled IoT Display, ESP32-S2 in the Wild and More!

Microsoft MakeCode — Resources for Students and Educators

Get the only spam-free daily newsletter about wearables, running a "maker business", electronic tips and more! Subscribe at AdafruitDaily.com !



No Comments

No comments yet.

Sorry, the comment form is closed at this time.