STFishFinder API  API version 0.0.0, Documentation version 3 -PRELIMINARY-
The STFishFinder API
The STFishFinder API is a C++11-based library that contains the platform-independent components of the Fish Finder API.
The STFishFinder API provides the following features:
  • Facilities to initiate communication with an FE2 black box fish finder.
  • "Setter" functions to change common fish finder settings such as range, gain, frequency selection, STC, Fish ID, alarms, etc.
  • "Getter" functions to read current settings and parameters, and retrieve data for display to the user.
  • Selection of units for depth, speed, and temperature.
  • Callback-based notifications of events such as: a change in depth alarm state, a detected fish, or an automatic setting change.
  • A fully functional simulator mode that provides simulated data for demonstration purposes, in the absence of an actual FE2 black box.
  • Record and playback facilities, to allow saving and replaying sessions.
  • Calibration facilities for speed, temperature, and sonar speed of sound.
  • Facilities to perform an over-the-air firmware update to an FE2 black box.
  • Designed for thread safety and reentrancy.
  • Object-oriented design.
The STFishFinder API has been designed to be largely platform-agnostic. See Porting the STFishFinder API to a New Platform for details regarding system requirements.
In addition, the STFishFinder API is not dependent on any particular network type: it can be used with any connection provided by the specific model of black box being used. This is because the networking aspects of the Fish Finder API are decoupled from the API itself, and are handled by a wrapper for the respective platform. For example, the model FE2 supports (simultaneously) both Wi-Fi (802.llb/g/n) and an asynchronous serial connection such as RS-232 or RS-485. Future versions of the black box might support Bluetooth or wired Ethernet.
See also
API Overview
Wrappers
Using the STFishFinder API