STFishFinder API  API version 0.0.0, Documentation version 3 -PRELIMINARY-
Setters for Master Settings

Functions for changing Master Settings. More...

Functions

FF_Error_t STFF::STFishFinder::SetTemperatureOffset (FF_TemperatureUnits_t units, int16_t temperatureOffset)
 Setter function to specify the Temperature Offset calibration setting for the black box. More...
 
FF_Error_t STFF::STFishFinder::SetSpeedPulsesPerNauticalMile (uint32_t speedPPNM)
 Setter function to specify the Speed Pulses Per Nautical Mile (PPNM) setting used by the black box to determine Speed Through Water. More...
 
FF_Error_t STFF::STFishFinder::SetDepthAlarmSettings (FF_DepthUnits_t units, uint32_t shallowAlarmSetting, uint32_t deepAlarmSetting)
 Setter function to set the Shallow Depth Alarm and Deep Depth Alarm master settings within the black box. More...
 

Detailed Description

Functions for changing Master Settings.

These are member functions of the STFishFinder class.

Unlike Local Settings, which only affect the present display and application, Master Settings globally affect all displays and applications that are simultaneously connected to the same black box. Master Settings are saved in nonvolatile memory within the black box and restored on each power up. They should not be stored in the local application's persistent storage, and the setters for Master Settings should not be called as a matter of course when the setters for Local Settings are called during API initialization .

Changing a Master Setting will cause a message to be sent to all display devices that are connected to the black box at the time the setting is changed. This message will result in the Callback_SettingChanged_t callback function being called on all connected devices. As a consequence of this behavior, if another connected display device calls one of these functions, the Callback_SettingChanged_t callback in the present application might be called at any time without warning to notify the application of the changed setting.

See also
Getters for Master Settings
Setters

Function Documentation

STFF::STFishFinder::SetDepthAlarmSettings ( FF_DepthUnits_t  units,
uint32_t  shallowAlarmSetting,
uint32_t  deepAlarmSetting 
)

#include <STFF-FishFinder.h>

Setter function to set the Shallow Depth Alarm and Deep Depth Alarm master settings within the black box.

The Depth Alarm settings are a Master Setting , affecting all devices that connect to the presently connected black box. These settings are saved in the non-volatile memory within the black box and restored on each power-up.

Parameters
[in]unitsthe depth units in which the shallowAlarmSetting and deepAlarmSetting are provided. Note that the Shallow and Deep alarms must both be specified in the same units.
[in]shallowAlarmSettingthe new value for the Shallow Depth Alarm setting. This value will be in hundredths of the unit specified in the units value. For example, if the specified units value is FF_DEPTH_UNITS_METERS, and the specified shallowAlarmSetting value is 300, then this establishes a Shallow Depth Alarm setting of 3.0 meters. If the depth becomes shallower than the Shallow Depth Alarm setting, this will trigger the invocation of the Callback_DepthAlarmStateChange_t callback function. To disable the Shallow Depth Alarm, set this parameter to 0.
[in]deepAlarmSettingthe new value for the Deep Depth Alarm setting. This value will be in hundredths of the unit specified in the units value. For example, if the specified units value is FF_DEPTH_UNITS_METERS, and the specified deepAlarmSetting value is 500, then this establishes a Deep Depth Alarm setting of 5.0 meters. If the depth becomes deeper than the Deep Depth Alarm setting, this will trigger the invocation of the Callback_DepthAlarmStateChange_t callback function. To disable the Deep Depth Alarm, set this parameter to 0.
Return values
FF_ERR_NO_ERRORif the operation completed successfully
FF_ERR_ARGUMENT_OUT_OF_RANGEif any of the input parameters is outside the range of allowable values.
FF_ERR_API_NOT_INITIALIZEDif the API status is not FF_API_STATUS_READY prior to calling this function
FF_ERR_BAD_DATABASEif the API encounters an internal error
Callback
This function will cause the Callback_SettingChanged_t callback function to be invoked in the present app, as well as on all fish finder apps (in all devices) simultaneously connected to the same black box. The parameters to that callback will be as follows:
Callback Parameter Value
FF_SettingType_t FF_SETTING_TYPE_MASTER_DEPTH_ALARM_SETTING
FF_Frequency_t FF_INVALID_FREQUENCY
const STFishFinder* pointer to the present instance of the STFishFinder class
Note
Do not call this function before the API status has reached FF_API_STATUS_READY. See How To Connect to a Black Box Fish Finder for details.

Refer to Setters for a general description of the actions performed by setters such as this function, and the subsequent events that result.

See also
GetDepthAlarmSettings()
How To Use the Depth Alarms
Setters
STFF::STFishFinder::SetSpeedPulsesPerNauticalMile ( uint32_t  speedPPNM)

#include <STFF-FishFinder.h>

Setter function to specify the Speed Pulses Per Nautical Mile (PPNM) setting used by the black box to determine Speed Through Water.

This setting affects the water speed reading provided by the GetSpeed() function.

Remarks
Manufacturer's specifications for commonly-available paddlewheel sensors typically claim a nominal pulse rate of 20,000 PPNM (which is equivalent to approximately 5.56 Hertz per knot). The actual pulse rate varies from one installation to the next, depending on the rate of water flow at the specific mounting location of the paddlewheel sensor on the vessel.

The Speed PPNM setting is a Master Setting , affecting all devices that connect to the presently connected black box. This setting is saved in the non-volatile memory within the black box and restored on each power-up.

Parameters
[in]speedPPNMthe requested Speed PPNM setting. The value of the speedPPNM parameter must fall within the range of values specified by the GetSpeedPulsesPerNauticalMileLimits() function.
Return values
FF_ERR_NO_ERRORif the operation completed successfully
FF_ERR_ARGUMENT_OUT_OF_RANGEif the input parameter is outside the range of allowable values.
FF_ERR_API_NOT_INITIALIZEDif the API status is not FF_API_STATUS_READY prior to calling this function
FF_ERR_BAD_DATABASEif the API encounters an internal error
Callback
This function will cause the Callback_SettingChanged_t callback function to be invoked in the present app, as well as on all fish finder apps (in all devices) simultaneously connected to the same black box. The parameters to that callback will be as follows:
Callback Parameter Value
FF_SettingType_t FF_SETTING_TYPE_MASTER_SPEED_PPNM
FF_Frequency_t FF_INVALID_FREQUENCY
const STFishFinder* pointer to the present instance of the STFishFinder class
Note
Do not call this function before the API status has reached FF_API_STATUS_READY. See How To Connect to a Black Box Fish Finder for details.

Refer to Setters for a general description of the actions performed by setters such as this function, and the subsequent events that result.

See also
GetSpeed()
GetSpeedPulsesPerNauticalMile()
GetSpeedPulsesPerNauticalMileLimits()
Setters
STFF::STFishFinder::SetTemperatureOffset ( FF_TemperatureUnits_t  units,
int16_t  temperatureOffset 
)

#include <STFF-FishFinder.h>

Setter function to specify the Temperature Offset calibration setting for the black box.

This setting is used to apply a correction to the water temperature reading provided by the GetTemperature() function. The Temperature Offset value is added to the raw temperature value to produce the corrected value reported by GetTemperature().

The Temperature Offset setting is a Master Setting , affecting all devices that connect to the presently connected black box. This setting is saved in the non-volatile memory within the black box and restored on each power-up.

Parameters
[in]unitsThe temperature units (Celsius or Fahrenheit) in which the temperatureOffset parameter is specified.
[in]temperatureOffsetthe requested Temperature Offset setting, in hundredths of the specified units. For example, if the required Temperature Offset is -1.5 degrees Celsius, then the temperatureOffset parameter would be -150, and the units parameter would be FF_TEMPERATURE_UNITS_CELSIUS. The value of the temperatureOffset parameter must fall within the range of values specified by the GetTemperatureOffsetLimits() function.
Return values
FF_ERR_NO_ERRORif the operation completed successfully
FF_ERR_ARGUMENT_OUT_OF_RANGEif either of the input parameters is outside the range of allowable values.
FF_ERR_API_NOT_INITIALIZEDif the API status is not FF_API_STATUS_READY prior to calling this function
FF_ERR_BAD_DATABASEif the API encounters an internal error
Callback
This function will cause the Callback_SettingChanged_t callback function to be invoked in the present app, as well as on all fish finder apps (in all devices) simultaneously connected to the same black box. The parameters to that callback will be as follows:
Callback Parameter Value
FF_SettingType_t FF_SETTING_TYPE_MASTER_TEMPERATURE_OFFSET
FF_Frequency_t FF_INVALID_FREQUENCY
const STFishFinder* pointer to the present instance of the STFishFinder class
Note
Do not call this function before the API status has reached FF_API_STATUS_READY. See How To Connect to a Black Box Fish Finder for details.

Refer to Setters for a general description of the actions performed by setters such as this function, and the subsequent events that result.

See also
GetTemperatureOffset()
GetTemperatureOffsetLimits()
Setters