STFishFinder API  API version 0.0.0, Documentation version 3 -PRELIMINARY-
API Overview
The STFishFinder API presents an abstraction of the FE2 black box fish finder to client application software needing to provide a fish finder GUI (graphical user interface) to the user.
The API has been designed for portability to various platforms, such as iOS, Android, Windows, and Linux. These various platforms each use a different predominant programming language (Objective-C, Java, CLI/.Net, and C++, respectively). In order to accommodate such diverse platforms without writing completely separate APIs, the Fish Finder API is organized into two distinct components:
  • a platform-independent C++11 "inner API", known as the STFishFinder API, which comprises the bulk of the API, and
  • a platform-specific wrapper, written in the predominant language for the platform, which provides the interface to the system and to the application program.
The diagram below shows a high-level overview of the interfaces and usages for the components in a typical iOS fish finder app. Diagrams for other platforms would be similar.
Fish_Finder_API_Component_Diagram4.png