PROFET™+ 24V Shield

class Btt60xxShield : private hss::HssShield 

Profet (24V) shield with BTT6030-2EKA and BTT6020-1EKA API.

Subclassed by hss::Btt60xxShieldIno

Public Functions

Btt60xxShield(Hss *hsw0, Hss *hsw1, Hss *hsw2)

Profet 24V BTT60xx Shield constructor.

Parameters:

hsw0 – [in] High-side switch 0 instance
hsw1 – [in] High-side switch 1 instance
hsw2 – [in] High-side switch 2 instance

~Btt60xxShield(): Destructor of the Profet 24V Shield.

virtual Error_t init()

Initialize all necessary objects of the Profet 24V Shield.

This function initializes all necessary objects of the Profet 24V Shield. It returns an error code to see if everything was initialized correctly.

Returns:: High-side switch error code

virtual Error_t deinit()

Deinitialize all necessary objects of the Profet 24V Shield.

This function deinitializes all necessary objects of the Profet 24V Shield. It returns an error code to see if everything was deinitialized correctly.

Returns:: High-side switch error code

virtual Error_t switchHxOn(uint8_t x)

Switch on the selected High-Side-Switch.

This function turns on the desired High-Side-Switch.

Parameters:

x – [in]

Number of the Switch the should be turned on (0-4). Possible values:

Switch 0 - Profet 0 (BTT6030 - channel 0)

Switch 1 - Profet 0 (BTT6030 - channel 1)

Switch 2 - Profet 1 (BTT6030 - channel 0)

Switch 3 - Profet 1 (BTT6030 - channel 1)

Switch 4 - Profet 2 (Single channel)

Returns:

High-side switch error code

virtual Error_t switchHxOff(uint8_t x)

Switch off the selected High-Side-Switch.

This function turns off the desired High-Side-Switch.

Parameters:

x – [in]

Number of the Switch the should be turned on (0-4). Possible values:

Switch 0 - Profet 0 (BTT6030 - channel 0)

Switch 1 - Profet 0 (BTT6030 - channel 1)

Switch 2 - Profet 1 (BTT6030 - channel 0)

Switch 3 - Profet 1 (BTT6030 - channel 1)

Switch 4 - Profet 2 (Single channel)

Returns:

High-side switch error code

Error_t switchesHxOn(bool h0_0 = false, bool h1_0 = false, bool h0_1 = false, bool h1_1 = false, bool h2 = false)

Turn on the selected High-Side-Switches.

This function is used to enable multiple switches at once.

Parameters:

h0_0 – [in] Enable the Switch 0 - channel 0 if h0_0 = true
h1_0 – [in] Enable the Switch 0 - channel 1 if h1_0 = true
h0_1 – [in] Enable the Switch 1 - channel 0 if h0_1 = true
h1_1 – [in] Enable the Switch 1 - channel 1 if h1_1 = true
h2 – [in] Enable the Switch 2 - channel 0 if h2 = true

Returns:

High-side switch error code

Error_t switchesHxOff(bool h0_0 = false, bool h1_0 = false, bool h0_1 = false, bool h1_1 = false, bool h2 = false)

Turn off the selected High-Side-Switches.

This function is used to disable multiple switches at once.

Parameters:

h0_0 – [in] Disable the Switch 0 - channel 0 if h0_0 = true
h1_0 – [in] Disable the Switch 0 - channel 1 if h1_0 = true
h0_1 – [in] Disable the Switch 1 - channel 0 if h0_1 = true
h1_1 – [in] Disable the Switch 1 - channel 1 if h1_1 = true
h2 – [in] Disable the Switch 2 - channel 0 if h2 = true

Returns:

High-side switch error code

virtual DiagStatus_t readDiagx(uint8_t x)

Read the diagnosis of the chosen channel.

This function uses the current signal of the channel to diagnose perform diagnosis. It returns the different states depending on the channels condition.

Parameters:

x – [in]

Number of the Switch the should be turned on (0-4). Possible values:

Switch 0 - Profet 0 (BTT6030 - channel 0)

Switch 1 - Profet 0 (BTT6030 - channel 1)

Switch 2 - Profet 1 (BTT6030 - channel 0)

Switch 3 - Profet 1 (BTT6030 - channel 1)

Switch 4 - Profet 2 (Single channel)

Return values:

0 – Everything works correctly
2 – Short to ground
4 – Short to battery
5 – Open load

Returns:

DiagStatus_t

virtual float readIsx(uint8_t x)

Read the desired current value of the chosen channel.

This function:

Enables diagnosis for the channel
Selects the channel through dsel
Calls function to get the calibrated sensed current value on chosen channel
Disables diagnosis pin post operation completion

Parameters:

x – [in]

Number of the Switch the should be turned on (0-4). Possible values:

Switch 0 - Profet 0 (BTT6030 - channel 0)

Switch 1 - Profet 0 (BTT6030 - channel 1)

Switch 2 - Profet 1 (BTT6030 - channel 0)

Switch 3 - Profet 1 (BTT6030 - channel 1)

Switch 4 - Profet 2 (Single channel)

Returns:

The calibrated value of the current in [A]