• OctoMY API
  • OctoMY API Reference
  • C++ Classes
  • OctoMY
  • BoardDatabase
  • BoardDatabase Class

    Finds the board that a USB id or a device signature belongs to, from the board definitions that libboard carries. More...

    Header: #include <BoardDatabase>
    Since: 1.0

    Detailed Description

    load() reads every board JSON file of schema version 2 or later from a resource folder, :/board/boards by default, into BoardData values. It then indexes the boards by USB vendor and product id, and by device signature. candidatesByVidPid() returns nothing for the generic USB-to-serial chips (CH340, FT232, CP2102 and PL2303), because many boards share them. The probe then needs the device signature.

    The class is a thin layer on BoardData that keeps the older BoardRecord interface alive for the callers that still use it. ControllerWidget and FixoHardwareWidget in libfixo each create one, load it, and give a raw pointer to the probe steps (VidPidProbeStep and AvrSignatureProbeStep). The widget deletes the database in its destructor.

    See also BoardData.