Todo List

Class FF_FishData_t

The present contents of the FF_FishData_t struct are only tentative; these need to be firmed up.

Class FF_FishIdSetting_t

The present contents of the FF_FishIdSetting_t struct are only tentative; these need to be firmed up.

Class STFF::STFishFinder

Add a member function to reset non-volatile memory in the black box to factory default

Add a module for providing firmware updates to the black box

Rename FishAlarmTrigger callback to FishDetected. (This callbacks would be used for both fish alarms and Fish ID.)

Add setter and getter functions for Fish Alarm functionality.

Eliminate FF_WaterType_t, and GetWaterType() and SetWaterType(). Replace all with GetSoundSpeed() and SetSoundSpeed(), and add constants for soundspeed for saltwater and freshwater.

Define attribute getters to provide both short form and long form copyright and license info for both the API and the black box firmware, in a choice of limited html or plain text.

Create SetBitDepth() and GetBitDepth() functions.

Add getters and setters for adjusting the STC.

Add getters and setters for adjusting sonar image filters (such as, e.g. water filter, clutter filter, noise filter, interference rejection, and DSP BW filters)

Member STFF::STFishFinder::Control (FF_ControlCommand_t command, const void *pParam)

Add a command to the Control() method to specify whether the API and black box should use a secondary communication channel (e.g. UDP instead of TCP) for transmission of Image data.

Add a command to the Control() method to enable or disable calls to individual callbacks

Member STFF::STFishFinder::GetBootloaderVersion (char *pBootloaderVersion, uint16_t *pLength, FF_DataStatus_t *pStatus) const

Redefine the GetBootloaderVersion() function to return a STFF::Version object instead of a string

Member STFF::STFishFinder::GetFWVersion (char *pFWVersion, uint16_t *pLength, FF_DataStatus_t *pStatus) const

Redefine the GetFWVersion() function to return a STFF::Version object instead of a string

Member STFF::STFishFinder::GetMaxPossibleDepth (FF_Frequency_t frequency, FF_DepthUnits_t units, uint32_t *pMaxDepth, FF_DataStatus_t *pStatus) const

The GetMaxPossibleDepth() function should probably be deprecated.