MobileCollect EVO API

With the MobileCollect EVO API you no longer need to have users download MobileCollect Xpress or MobileCollect Extended for setting up transmitters. We developed this API for three reasons.

1. Streamline Setup. The API allows any software to setup MobileCollect Transmitters to EVO Bases. You can retain control of the user experience and implementation of MobileCollect systems.

2. Enriched Data. We can send much more than just a measurement. For advanced systems, you may want more information such as the unique Module ID, units, gap time between readings, signal strength, and more to come through with each measurement. This can be configured through the API, without the need for user input, ensuring all devices are sending the information you want.

3. Consistency. With the API, you can update the MobileCollect System when you detect an inconsistency with incoming data on-the-fly. This can all be done behind the scenes without the need for user input.

Advanced setup will still need to take place in MobileCollect Xpress or MobileCollect Extended Setup software. There are currently two setup configuration files that the MobileCollect Base utilizes; Xpress Setup and Extended Setup. The base only utilizes one configuration file at a time, either Xpress or Extended. This API is based off the Xpress Setup configuration file and thus parameters set with the API will be visible in Xpress Setup.** For advanced configuration, have users go to Xpress Setup unless they are configuring a Remote Transmitter, Command Mobile Module, read switch, or need additional Channels. If they have these advanced setup needs, they will need to use Extended Setup and parameters set with the API will not display.

We have downloadable executables and user manuals on our website for both Xpress and Extended Setup.

** The API offers additional flexibility over Xpress Setup and some parameters may not show exactly as they we’re setup via the API. This may lead users to change settings in Xpress and those settings will have to be reconfigured via the API

Supported MobileCollect Bases

• All MobileCollect EVO Base Models will have API support. Model ID
  • Wedge Base EVO: MC-BK306-A
  • RS-232 Base EVO: MC-BR306-A
  • USB Base EVO: MC-BU306-A
  • MicroBase EVO USB A & USB C: MC-BM306-A
• Users must have MobileCollect EVO Base firmware 6.20 or higher to utilize the API – Download the latest firmware here.
  • All EVO bases will ship with Firmware 6.20 or newer and have API support.
• To check the base model and firmware version to confirm API support:
  • <V  Version Serial Command
    • Base Model Number, Firmware Version
    • Example Output: MC-BW306-A, 6.20
  • <$A:BMN Model API command (Firmware 6.28+)
    • Example Output: MC-BK306-A{CR}MBLAPI_SUCCESS{CR}<$A:BMN
  • <$A:BFV Firmware Version API command (Firmware 6.28+)
    • Example Output: 6.28{CR}MBLAPI_SUCCESS{CR}<$A:BFV

API Commands

• Case sensitive, you must use uppercase for all commands.
• Communication is done through a Virtual Com Port.
  • We recommend downloading MicroRidge ComTestSerial to get a feel for how the API communicates. This will allow you to send the API commands without writing any code to test the functionality.
• User will see API Confirmation LED blink sequence
  • Red LED on for 1 second
  • Yellow LED blink twice for 250ms while Red LED remains illuminated.
  • Total blink sequence duration = 1 second.
• API Confirmation gets sent back to host device (computer) at the end of every successful API call
  • Carriage Return (\x0d)
  • MBLAPI_SUCCESS
  • Carriage Return (\x0d)
  • Command Host Computer Sent (Example: <$A:ICLA)
  • Carriage Return (\x0d)