MultiTool Creator code template uses S_SL8X1_Diagnostic (PRG) for SL8X1 unit's HW diagnostics.

See the PRG's manual for description on diagnostics and functionalities that are implemented by library.

 

This guide gives application examples on controls that are required to be performed by the application and also information on status indications that are provided for application controls.

 

Code template

 

S_o_DiagStatusOk affects MultiTool Creator code template's status G_StatusFlags_Safe.S_SafeOperationEnable S_SafeOperationEnable is set FALSE if diagnostic error is detected in a functionalities which affect the S_o_DiagStatusOk. The application shall use S_SafeOperationEnable as a condition for safety related controls.

 

When code template is generated by MultiTool Creator, the S_Main PRG contains example on application controls for the HW diagnostic inputs.

  

Safety switch startup test

 

Safety switch startup test is triggered by application. This allows the application to delay the startup test execution, if necessary.

Delaying the startup test can be required in system condition where the supply voltage fluctuates after system bootup.

 

The startup test will perform tests for the safety switch and also check for external voltages in outputs. See product's safety manual for more information.

 

If application wants to avoid FW error during startup test due to the output's external voltage, the application can diagnose the outputs before triggering the startup test. See How to control DO & DO ECO for information on how to diagnose the output with DOS status.

 

 Startup test is started by setting following input TRUE:

Code:

EPEC_HWDIAG.S_SL8X1_Diagnostic.i_SwitchStartupTestEnable := TRUE;

  

Output group control

 

The default state of the output group control is OFF. Control conditions are application specific.

 

Output group control can only be activated once. After output group deactivation, reboot is required for output group re-activation.

 

Output group control is automatically deactivated in following conditions: if a firmware error is detected if output group validation error is detected if PCB1 temperature's safe limit is exceeded

 

After the startup test has been executed and output group is activated, the external voltage diagnostic in output pins is application's responsibility. See How to control DO & DO ECO for information on how to diagnose the outputs with DOS status.

 

Startup test execution is required before output group can be controlled. The code template's S_SafeOperationEnable status is not TRUE before output group diagnostic is enabled in library.

 

The output group diagnostic's enable status can also be read from following variable:

• EPEC_HWDIAG.S_SL8X1_Diagnostic.o_DiagEnableStates.OutputGroup1_Diagnostic_Enable

 

The following is an example of output group control

Code:

EPEC_HWDIAG.S_SL8X1_Diagnostic.i_OutputGroup1Control := G_StatusFlags_Safe.S_SafeOperationEnable;

 

The current state of control can be read by the application from the following variable:

• EPEC_HWDIAG.S_SL8X1_Diagnostic.S_o_OutputGroup1Control

 

Reference output control(s)

HW diagnostic library supports up to two REF outputs (REF A and REF B). Both REF outputs support 5V or 10V REF mode.

The MultiTool Creator's code template initializes automatically the REF output in use and mode parameters based on functional version's HW assembly.

Product	REF A	REF B
SL8X1-01	In use: TRUE Type: REF5V	In use: TRUE Type: REF10V

The default state of the REF output control is TRUE. Control conditions are application specific.

 

When REF output's in use is FALSE, the corresponding REF output is not available in product.

Product has REFOUT switch which is secondary shutdown path if hardware fault prevents REF output control request to disable REF voltage.

The HW diagnostic library automatically controls REFOUT switch off if persistent overvoltage error is detected from either of the REF outputs.

Following is example of REFOUT switch control.

Code:

EPEC_HWDIAG.S_SL8X1_Diagnostic.i_RefoutSwitchControl := TRUE;

Following is example of REF A and REF B control.

Code:

EPEC_HWDIAG.S_SL8X1_Diagnostic.i_RefAVoltageControl := TRUE; EPEC_HWDIAG.S_SL8X1_Diagnostic.i_RefBVoltageControl := TRUE;

The HW diagnostic library has automatic enable logic for REF output's diagnostic and control based on control unit's supply voltage.

This is done to protect the hardware and to prevent unnecessary errors.

See S_SL8X1_Diagnostic (PRG) for supply voltage limits for REF output diagnostic and control conditions.

If application's REF output control request is TRUE, the library automatically resumes REF control after supply voltage resumes in normal levels.

The state of REF output diagnostic enable can be read by the application from the following variables:

• EPEC_HWDIAG.S_SL8X1_Diagnostic.o_DiagEnableStates.REF_A_Diagnostic_Enable

• EPEC_HWDIAG.S_SL8X1_Diagnostic.o_DiagEnableStates.REF_B_Diagnostic_Enable

The state of REF output's control can be read by the application from the following variables:

• EPEC_HWDIAG.S_SL8X1_Diagnostic.S_o_RefAControl

• EPEC_HWDIAG.S_SL8X1_Diagnostic.S_o_RefBControl

The measured voltage of REF output can be read by the application from the following variables:

• EPEC_HWDIAG.S_SL8X1_Diagnostic.S_o_RefAVoltage

• EPEC_HWDIAG.S_SL8X1_Diagnostic.S_o_RefBVoltage

If REF output's REF_<X>_Diagnostic_Enable is FALSE (e.g. due to the supply voltage limits), the REF outputs OutputValid flag is FALSE and this is not considered error. The REF output has error only in situation where OutputValid is FALSE AND diagnostic has been enabled.

The validity of REF output's measurement can be checked by the application from the following variables:

• EPEC_HWDIAG.S_SL8X1_Diagnostic.o_RefAControlStatus.OutputValid

• EPEC_HWDIAG.S_SL8X1_Diagnostic.o_RefBControlStatus.OutputValid

Application output control conditions

 

The HW diagnostic library has status flags for application to indicate when supply voltage is in range where output controls can be used/activated.

The supply voltage enable flags are found from library output EPEC_HWDIAG.S_SL8X1_Diagnostic.o_SupplyVoltageEnableStates.

These statuses are not affected by the supply voltage's error diagnostics limits.

 

See S_SL8X1_Diagnostic (PRG) for output control's supply voltage limits.

For in depth guides on output control and diagnostics see Safety project How to guides. For example: How to control DO & DO ECO How to control proportional valves How to control PWM voltage valves How to use H-bridge controller

Following is an example of how to use HW diagnostic states with output control and diagnostics.

 

 

MultiTool Creator code template uses S_SM8X1_Diagnostic (PRG) for SM8X1 unit's HW diagnostics.

See the PRG's manual for description on diagnostics and functionalities that are implemented by library.

This guide gives application examples on controls that are required to be performed by the application and also information on status indications that are provided for application controls.

Code template

S_o_DiagStatusOk affects MultiTool Creator code template's status G_StatusFlags_Safe.S_SafeOperationEnable S_SafeOperationEnable is set FALSE if diagnostic error is detected in a functionalities which affect the S_o_DiagStatusOk. The application shall use S_SafeOperationEnable as a condition for safety related controls.

When code template is generated by MultiTool Creator, the S_Main PRG contains example on application controls for the HW diagnostic inputs.

  

Safety switch startup test

Safety switch startup test is triggered by application. This allows the application to delay the startup test execution, if necessary.

Delaying the startup test can be required in system condition where the supply voltage fluctuates after system bootup.

The startup test will perform tests for the safety switch and also check for external voltages in outputs. See product's safety manual for more information.

If application wants to avoid FW error during startup test due to the output's external voltage, the application can diagnose the outputs before triggering the startup test. See How to control DO & DO ECO for information on how to diagnose the output with DOS status.

 Startup test is started by setting following input TRUE:

Code:

EPEC_HWDIAG.S_SM8X1_Diagnostic.i_SwitchStartupTestEnable := TRUE;

  

Output group control

The default state of the output group control is OFF. Control conditions are application specific.

Output group control can only be activated once. After output group deactivation, reboot is required for output group re-activation.

Output group control is automatically deactivated in following conditions: if a firmware error is detected if output group validation error is detected if PCB1 temperature's safe limit is exceeded

After the startup test has been executed and output group is activated, the external voltage diagnostic in output pins is application's responsibility. See How to control DO & DO ECO for information on how to diagnose the outputs with DOS status.

Startup test execution is required before output group can be controlled. The code template's S_SafeOperationEnable status is not TRUE before output group diagnostic is enabled in library.

The output group diagnostic's enable status can also be read from following variable:

• EPEC_HWDIAG.S_SM8X1_Diagnostic.o_DiagEnableStates.OutputGroup1_Diagnostic_Enable

The following is an example of output group control

Code:

EPEC_HWDIAG.S_SM8X1_Diagnostic.i_OutputGroup1Control := G_StatusFlags_Safe.S_SafeOperationEnable;

The current state of control can be read by the application from the following variable:

• EPEC_HWDIAG.S_SM8X1_Diagnostic.S_o_OutputGroup1Control

Reference output control(s)

HW diagnostic library supports up to two REF outputs (REF A and REF B). Both REF outputs support 5V or 10V REF mode.

The MultiTool Creator's code template initializes automatically the REF output in use and mode parameters based on functional version's HW assembly.

Product	REF A	REF B
SM8X1-02	In use: FALSE Type: N/A	In use: FALSE Type: N/A

The default state of the REF output control is TRUE. Control conditions are application specific.

When REF output's in use is FALSE, the corresponding REF output is not available in product.

Product has REFOUT switch which is secondary shutdown path if hardware fault prevents REF output control request to disable REF voltage.

The HW diagnostic library automatically controls REFOUT switch off if persistent overvoltage error is detected from either of the REF outputs.

Following is example of REFOUT switch control.

Code:

EPEC_HWDIAG.S_SM8X1_Diagnostic.i_RefoutSwitchControl := TRUE;

Following is example of REF A and REF B control.

Code:

EPEC_HWDIAG.S_SM8X1_Diagnostic.i_RefAVoltageControl := TRUE; EPEC_HWDIAG.S_SM8X1_Diagnostic.i_RefBVoltageControl := TRUE;

The HW diagnostic library has automatic enable logic for REF output's diagnostic and control based on control unit's supply voltage.

This is done to protect the hardware and to prevent unnecessary errors.

See S_SM8X1_Diagnostic (PRG) for supply voltage limits for REF output diagnostic and control conditions.

If application's REF output control request is TRUE, the library automatically resumes REF control after supply voltage resumes in normal levels.

The state of REF output diagnostic enable can be read by the application from the following variables:

• EPEC_HWDIAG.S_SM8X1_Diagnostic.o_DiagEnableStates.REF_A_Diagnostic_Enable

• EPEC_HWDIAG.S_SM8X1_Diagnostic.o_DiagEnableStates.REF_B_Diagnostic_Enable

The state of REF output's control can be read by the application from the following variables:

• EPEC_HWDIAG.S_SM8X1_Diagnostic.S_o_RefAControl

• EPEC_HWDIAG.S_SM8X1_Diagnostic.S_o_RefBControl

The measured voltage of REF output can be read by the application from the following variables:

• EPEC_HWDIAG.S_SM8X1_Diagnostic.S_o_RefAVoltage

• EPEC_HWDIAG.S_SM8X1_Diagnostic.S_o_RefBVoltage

If REF output's REF_<X>_Diagnostic_Enable is FALSE (e.g. due to the supply voltage limits), the REF outputs OutputValid flag is FALSE and this is not considered error. The REF output has error only in situation where OutputValid is FALSE AND diagnostic has been enabled.

The validity of REF output's measurement can be checked by the application from the following variables:

• EPEC_HWDIAG.S_SM8X1_Diagnostic.o_RefAControlStatus.OutputValid

• EPEC_HWDIAG.S_SM8X1_Diagnostic.o_RefBControlStatus.OutputValid

Application output control conditions

The HW diagnostic library has status flags for application to indicate when supply voltage is in range where output controls can be used/activated.

The supply voltage enable flags are found from library output EPEC_HWDIAG.S_SM8X1_Diagnostic.o_SupplyVoltageEnableStates.

These statuses are not affected by the supply voltage's error diagnostics limits.

 

See S_SL8X1_Diagnostic (PRG) for output control's supply voltage limits.

For in depth guides on output control and diagnostics see Safety project How to guides. For example: How to control DO & DO ECO How to control proportional valves How to control PWM voltage valves How to use H-bridge controller

Following is an example of how to use HW diagnostic states with output control and diagnostics.