JoeScan Pinchot API¶

What is this "Pinchot" or "Pinchot API"?¶

Good question! Pinchot is a simple, easy-to-use, open source user space client API for creating and managing ScanSystems built with JoeScan JS-50 scanners. Originally, when we designed the API, we needed a code name, and we chose "Pinchot" after Gifford Pinchot, the first Chief of the United States Forest Service. We thought it was fitting, as Gifford Pinchot was a pioneer in the field of conservation and natural resource management.

Languages¶

Pinchot is offered in two languages, .NET C# and C; both versions of the API maintain feature parity. The examples section for C also contains a sample wrapper of the interface for C++. If you need to access Pinchot in another language (e.g. Python), please contact JoeScan.

Official Release¶

The official precompiled release of the API can be downloaded at api.joescan.com/release. Included with the API release are the tools FirmwareUpdate and SensorTester. It is recommended to use the official release if at all possible as it simplifies development and allows JoeScan to provide direct customer support. Additional software, like our integrated setup tool JsSetup, is available from the same page.

Open Source Release¶

Source code for the .NET C# API can be found on the project's Github page; the source for the C API can be found on it's Github page.

Limited customer support is provided for end users incorporating the open source release into their projects; please contact JoeScan if there are questions regarding which release is best suited for a given project.

Documentation¶

Documentation for the Pinchot API can be found with the respective API version, JoeScan.Pinchot.xml for .NET C# or joescan_pinchot.h for C. Alternatively, the most recent documentation corresponding with the latest public release of the API can be found online as well.