Open Source Calculator Teaches us about Quality Documentation

综合技术 2018-05-18 阅读原文

Graphing calculators are one of those funny markets that never seem to change. Standardized testing has created a primordial stew of regulatory capture in which ancient technology thrives at modern retail prices while changing little. The NumWorks calculator certainly isn’t the first competitor to challenge the Texas Instruments dynasty with a more modern interface (and a design from this decade), but behind it’s subtle color pops and elegant lines lies the real gem; a fantastically well documented piece of open source hardware. The last time we wrote about the NumWorks , it was to demonstrate a pretty wild hack that embedded an entire Pi Zero but it’s worth drawing attention to the calculator itself.

Hackaday readers traveling to the NumWorks website might spy the section at the bottom of the page titled “Developers” with tantalizing links like “ Hardware ,” “ Software ,” and “ GitHub .” These lead to a wealth of knowledge about how the product is put together and sources to build the enclosure and firmware yourself (the PCB schematic and layout sources seem to be missing, though there is this handy gerber viewer ). However merely posting sources is a low bar NumWorks far exceeds.

How is the firmware put together? Here’s a handy architecture guide ! Why did they choose C++ and what tradeoffs were made to fit everything in a resource constrained embedded system? Here’s a design guide ! How exactly does the math engine take in text, comprehend the expression contained therein, and evaluate it? There’s a document for it! There’s even a multi-platform SDK setup guide .

Firmware documentation is old hat; we’ve come to expect (or at least hope!) for it. For us the most interesting documentation is actually for the mechanical and electrical systems. The EE guides start with part selection (with datasheet links) then move on to walkthroughs of major areas of the schematic . At this point is should be no surprise that the board has pads for a completely standard 10 pin ARM debug connector and documented test points for UART, SPI, and an SD card.

The mechanical pages read like a quick primer on design for injection molding and tricks to reduce assembly errors (called “ poka-yoke “). Ever wondered what that funny frame plastic models come in is called? The NumWorks calculator’s buttons are made in one , and it’s called a “sprue”. There are pages describing each piece of the housing one at a time.

Treat yourself to a reading of NumWorks’ excellent documentation. And if you need a new calculator, maybe consider the open source option.

Hack a Day

责编内容by:Hack a Day阅读原文】。感谢您的支持!

您可能感兴趣的

开源中国 Android 客户端 v2.8.9 代码开源 传承我大OSC的光荣传统,继昨天发布 开源中国 Android 客户端 v2.8.9 版本 之后,今天我们如约双手奉上该版本源码,敬请各位OSCer们笑纳! 新增:编写并发布博客功能 新增:资讯、博客详情界面中长...
OSC 年度事件大盘点,九周年贺礼等你来拿!... 开源已“九”,不忘初心 —— 开源中国九周年特别献礼! 2008 年 8 月 31 日,OSChina 网站正式上线。到今天已经整整 9 个年头。 那一年,我看的还是《 x 语言入门》,现在已经看到这个系列的最后一本《颈椎病康复指...
代理可以一对多吗? —使用开源库要慎重... 开源库的使用我们需要注意其所属协议,比如MIT、BSD等,注意这些协议不允许你做些什么。但这个不是本文重点。 本文结合一个多重代理的库的解析和使用,来讲一下使用开源库中使用部分代码时的问题。 我们都知道“协议” protoco...
满血复活:阿里的开源Dubbo 3.0要来了!... 概述 2018年1月8日夜间,Dubbo 创始人之一梁飞在 Dubbo 交流群里透露了 Dubbo 3.0 正在动工的消息。 什么是Dubbo 百度百科上说: Dubbo是阿里巴巴公...
Folding@Home Android Client and Web Server Compone... Folding@Home is the product of a partnership between Pande Lab and Stanford University dating all the way back to its i...