Bristlemouth Technical Docs Are Live!

With the launch this week, we’ve released the first round of Bristlemouth technical documentation. The main site is [here].

Useful Links

  • v1.0.0 of the Bristlemouth Standard Specification, which covers hardware and low level networking interfaces. [here]
  • v0.1.0 of the open source Bristlemouth Protocol, and associated protocol design documentation. [here]
  • Specs and drawings of the Bristlemouth Development Kit. [here]
  • Open source electrical schematics for Sofar’s implementation of a Bristlemouth Mote and Development Board are available in the Downloads section [here].
  • A suite of Bristlemouth Development Kit User Guides are posted [here]

Coming soon

  • v1.0.0 release of the Bristlemouth Protocol
  • Yet more detailed developer guides for the Bristlemouth Development Kit

Commenting on the Wiki

We use notion as a documentation platform. If you create a free notion account and login, you can comment directly in the Bristlemouth Wiki with questions and suggestions.

1 Like

A brief update - more documents! (links edited into OP).

  • Open source electrical schematic for Sofar’s first Bristlemouth Mote, and the Bristlemouth Development Board carrier board.
  • First Bristlemouth Development Kit user guides are published.
2 Likes

Hello all! More dev kit user guides have been released!

BMDK User Guides

Updates!:

  • We’ve added a lot of detain to the Mote Firmware Update Guide, including how to use the swanky new buttons on the AD version of the Bristlemouth Development Board to force the processor into USB bootloader mode.
  • We’ve added an SWD-over-USB-C Guide, which explains how to obtain and use a very nice tool for advanced developers - an adapter that merges SWD signals from an STLink debugger onto USB-C pins. That way you can simultaneously run an SWD debugging session and USB serial console to your Dev Kit Mote over the same USB-C physical connection! :exploding_head:
1 Like

A minor documentation update today - a more detailed description of the SD card logging files a Bristlemouth Spotter will generated for attached OTS Bristlemouth sensors: Notion – The all-in-one workspace for your notes, tasks, wikis, and databases.

1 Like

We just published a hefty new doc - a guide on managing firmware versions and updates across an entire Bristlemouth system (including with Spotter and Smart Mooring).

Guide: Managing Spotter & Bristlemouth Firmware Versions

This one is a doozy, but we strongly recommend early Pioneer and Dev Kit users go through the effort to get their systems up-to-date (Bristlemouth v0.11.1 + Spotter v2.15.1). There have been steady features, improvements and bug fixes since the earlier releases.

• If you need help getting through this - we’re here for you!
• Yes - the process is cumbersome and complex today, but also conducive to future automation with supporting tooling.

2 Likes

We just published a new Bristlemouth Dev Kit sensor integration guide that covers how to connect an RS-485 sensor (an INNOVASEA Rx-LIVE acoustic fish tag receiver) to a Dev Kit.
Check it out [here]!

This guide covers:

  • New PLUART transactions management feature, which is useful for any Half-Duplex or custom flow control use case.
  • New RS-485 HAL convenience wrappers for the Bristlemouth Dev Board.
  • New String type supported in the LineParser class for building more complex serial protocol parsers.
  • An example of how to implement an embedded state machine like it’s 1999.

You should also check out @estackpole’s thread detailing the adventure and ultimate successful test deployment for this integration: https://bristlemouth.discourse.group/t/integrating-an-rs-485-device-rx-live-acoustic-animal-tag-receiver-with-bristlemouth

4 Likes