MicroSpec Documentation

Overview

microspec is Chromation’s Spectrometer dev-kit interface. It contains:

• Python package microspeclib

  a collection of dev-kit interface functions

• command line utility microspec-cmdline

  run basic measurements without developing a Python application

How the documentation is organized

At the moment, this documentation is mostly reference. Tutorials and How-To Guides are coming soon.

Detailed table of contents

Contents:

• Getting Started
• How To Read This Documentation
  • Best way
  • No documentation in the source code
  • Other options to read the docs
• Writing Applications
• Dev-kit API
• Dev-kit API Guide
  • Two Most Important Docs
  • API Commands
  • API Replies
  • View API replies at the REPL
  • Other Useful Docs
• How to handle timeouts
• Under The Hood (How microspeclib works)
  • Hardware under the hood
  • Two APIs: simple and expert
  • Where is the code?
• Contributing to MicroSpec
  • Setup
• microspeclib
  • microspeclib package
  • bin package
  • cfg package
  • tests package
• bin package
  • Submodules
• cfg package
  • microspec.cfg (dev-kit API protocol)
• tests package
  • Submodules

Indices and tables

• Index

• Module Index

• Search Page