Add command builders for the DI object by hms-toth · Pull Request #31 · hms-networks/abcc-driver-api

hms-toth · 2026-02-13T12:52:41Z

'Command builders' for the Diagnostic Object has been added. I.e. functions that writes a correctly formatted command to a given message buffer. The host application must still send the command, that is not handled by those builder functions.

Copilot

Pull request overview

This PR adds command builder functions for the Diagnostic Object (DI) in the Anybus CompactCom driver API. These builder functions format diagnostic event commands for the ABCC, including support for generic diagnostic events, extended diagnostic data, and PROFINET-specific channel diagnostics. The host application remains responsible for sending the commands after they are built.

Changes:

Added diagnostic_object.c/.h files with builder functions for creating diagnostic event commands
Integrated the new files into the build systems (cmake and mk)
Included validation logic for PROFINET-specific diagnostic parameters

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 10 comments.

File	Description
src/anybus_objects/diagnostic_object.c	Implementation of DI command builders with validation functions for PROFINET parameters
inc/anybus_objects/diagnostic_object.h	Public API declarations, constants, and extensive usage examples for DI command builders
abcc-driver-api.mk	Added diagnostic_object.c to the makefile build sources
abcc-driver-api.cmake	Added diagnostic_object.c/.h to the CMake build system

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-13T13:39:52Z

src/anybus_objects/diagnostic_object.c

+
+   /*
+   ** DI_BuildCmdAddExtDiag() is supposed to be called after
+   ** DI_BuildCmdCreateDiag() as written its data to the message buffer.


The comment contains a grammatical error: "as written" should be "has written" or "after it has written".

Suggested change

** DI_BuildCmdCreateDiag() as written its data to the message buffer.

** DI_BuildCmdCreateDiag() has written its data to the message buffer.

Copilot · 2026-02-13T13:39:53Z

src/anybus_objects/diagnostic_object.c

+   {
+      /*
+      ** The caller can not select the ChannelProperties.Specifier value.
+      ** It must be locked to Appears, and the ABCC generated the Disappears


The comment contains a grammatical error: "the ABCC generated the Disappears" should be "the ABCC generates the Disappears".

Suggested change

** It must be locked to Appears, and the ABCC generated the Disappears

** It must be locked to Appears, and the ABCC generates the Disappears

Copilot · 2026-02-13T13:39:53Z

inc/anybus_objects/diagnostic_object.h

+{ 2, PD_READ,  AD_MAP_ALL_ELEM, 0 },
+
+/*
+** Now, our monitoring hardware for the outputs has detected a short circut on


The comment contains a typo: "short circut" should be "short circuit".

Suggested change

** Now, our monitoring hardware for the outputs has detected a short circut on

** Now, our monitoring hardware for the outputs has detected a short circuit on

Copilot · 2026-02-13T13:39:53Z

inc/anybus_objects/diagnostic_object.h

+**
+** NOTE:
+** The functions, constants, bitmasks, values, and descriptions here are not
+** intended to be a substitue for the PROFINET specification. It is assumed


The comment contains a typo: "substitue" should be "substitute".

Suggested change

** intended to be a substitue for the PROFINET specification. It is assumed

** intended to be a substitute for the PROFINET specification. It is assumed

Copilot · 2026-02-13T13:39:53Z

src/anybus_objects/diagnostic_object.c

+   iTemp = ( iTemp & ~( DI_PRT_CHAN_PROP_MAINT_MASK ) ) | DI_PRT_CHAN_PROP_MAINT_QUALIFIED;
+   ABCC_SetMsgData16( psMsg, iTOiBe( iTemp ), ( iOffset - ( DI_PRT_CHAN_DIAG_LEN + DI_PRT_EXT_CHAN_DIAG_LEN ) ) + ABP_UINT16_SIZEOF + ABP_UINT16_SIZEOF );
+
+   lTemp = 1 << bChannelQualifier;


The expression 1 << bChannelQualifier is potentially problematic. When bChannelQualifier is 31, shifting the integer literal 1 (which is of type int) left by 31 bits results in undefined behavior in C if int is 32 bits (the sign bit would be set). The literal should be explicitly unsigned or of type UINT32. Use 1U << bChannelQualifier or (UINT32)1 << bChannelQualifier instead.

Suggested change

lTemp = 1 << bChannelQualifier;

lTemp = ( (UINT32)1 << bChannelQualifier );

Copilot · 2026-02-13T13:39:54Z

inc/anybus_objects/diagnostic_object.h

+#include "abcc.h"
+


The macro DI_OBJ_ENABLE is used but never defined anywhere in the codebase. This will cause compilation issues or incorrect behavior. Following the pattern of other objects in the codebase (e.g., ANB_FSI_OBJ_ENABLE), the header file should include "../../src/abcc_api_config.h" before checking DI_OBJ_ENABLE, and DI_OBJ_ENABLE should be defined in src/abcc_api_config.h with a default value (typically 0).

Suggested change

#include "abcc.h"

#include "abcc.h"

#include "../../src/abcc_api_config.h"

#ifndef DI_OBJ_ENABLE

#define DI_OBJ_ENABLE 0

#endif

Copilot · 2026-02-13T13:39:54Z

src/anybus_objects/diagnostic_object.c

+   return( ABCC_EC_NO_ERROR );
+}
+
+ABCC_ErrorCodeType DI_BuildCmdAddExtDiag( ABP_MsgType* psMsg, UINT16 iSlot, UINT16 iAdi, UINT8 bElement, UINT8 bBitInElement )


The parameter name in the function declaration (bBit) doesn't match the implementation (bBitInElement). While this is technically allowed in C, it creates inconsistency and potential confusion. The parameter names should match between the header and source file for better maintainability.

Suggested change

ABCC_ErrorCodeType DI_BuildCmdAddExtDiag( ABP_MsgType* psMsg, UINT16 iSlot, UINT16 iAdi, UINT8 bElement, UINT8 bBitInElement )

ABCC_ErrorCodeType DI_BuildCmdAddExtDiag( ABP_MsgType* psMsg, UINT16 iSlot, UINT16 iAdi, UINT8 bElement, UINT8 bBit )

Copilot · 2026-02-13T13:39:54Z

src/anybus_objects/diagnostic_object.c

+
+/*------------------------------------------------------------------------------
+** Perform some basic sanity checks on the PROFINET-specific values that goes
+** int a ChannelDiagnosis of ExtChannelDiagnosis structure.


The comment contains a typo: "int a ChannelDiagnosis" should be "into a ChannelDiagnosis".

Suggested change

** int a ChannelDiagnosis of ExtChannelDiagnosis structure.

** into a ChannelDiagnosis of ExtChannelDiagnosis structure.

Copilot · 2026-02-13T13:39:54Z

src/anybus_objects/diagnostic_object.c

+      return( FALSE );
+   }
+
+   if( ( ( iChannelProperties & ~(DI_PRT_CHAN_PROP_TYPE_MASK) ) != DI_PRT_CHAN_PROP_TYPE_UNDEF ) &&


The bitwise logic appears incorrect. The condition checks if (iChannelProperties & ~(DI_PRT_CHAN_PROP_TYPE_MASK)) != DI_PRT_CHAN_PROP_TYPE_UNDEF. However, DI_PRT_CHAN_PROP_TYPE_UNDEF is 0x0000, and after masking out TYPE_MASK (0x00FF), any non-zero value in the upper bits would pass this check. The intent seems to be checking if the Type field is NOT Undefined, but the logic should be: ((iChannelProperties & DI_PRT_CHAN_PROP_TYPE_MASK) != DI_PRT_CHAN_PROP_TYPE_UNDEF).

Suggested change

if( ( ( iChannelProperties & ~(DI_PRT_CHAN_PROP_TYPE_MASK) ) != DI_PRT_CHAN_PROP_TYPE_UNDEF ) &&

if( ( ( iChannelProperties & DI_PRT_CHAN_PROP_TYPE_MASK ) != DI_PRT_CHAN_PROP_TYPE_UNDEF ) &&

Copilot · 2026-02-13T13:39:55Z

inc/anybus_objects/diagnostic_object.h

+*/
+
+/*
+** Build a 'Create diag. event' command with a "major, recovrable" severity,


The comment contains a typo: "recovrable" should be "recoverable".

Suggested change

** Build a 'Create diag. event' command with a "major, recovrable" severity,

** Build a 'Create diag. event' command with a "major, recoverable" severity,

Add command builders for the DI object

1671ef8

'Command builders' for the Diagnostic Object has been added. I.e. functions that writes a correctly formatted command to a given message buffer. The host application must still send the command, that is not handled by those builder functions.

DanRHMS requested a review from Copilot February 13, 2026 13:33

Copilot started reviewing on behalf of DanRHMS February 13, 2026 13:34 View session

Copilot AI reviewed Feb 13, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add command builders for the DI object#31

Add command builders for the DI object#31
hms-toth wants to merge 1 commit intohms-networks:mainfrom
hms-toth:add_di_object_wrapper

hms-toth commented Feb 13, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Copilot AI Feb 13, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	** DI_BuildCmdCreateDiag() as written its data to the message buffer.
	** DI_BuildCmdCreateDiag() has written its data to the message buffer.

	** It must be locked to Appears, and the ABCC generated the Disappears
	** It must be locked to Appears, and the ABCC generates the Disappears

	** Now, our monitoring hardware for the outputs has detected a short circut on
	** Now, our monitoring hardware for the outputs has detected a short circuit on

	** intended to be a substitue for the PROFINET specification. It is assumed
	** intended to be a substitute for the PROFINET specification. It is assumed

	lTemp = 1 << bChannelQualifier;
	lTemp = ( (UINT32)1 << bChannelQualifier );

-#include "abcc.h"
+#include "abcc.h"
+#include "../../src/abcc_api_config.h"
+#ifndef DI_OBJ_ENABLE
+#define DI_OBJ_ENABLE 0
+#endif

	ABCC_ErrorCodeType DI_BuildCmdAddExtDiag( ABP_MsgType* psMsg, UINT16 iSlot, UINT16 iAdi, UINT8 bElement, UINT8 bBitInElement )
	ABCC_ErrorCodeType DI_BuildCmdAddExtDiag( ABP_MsgType* psMsg, UINT16 iSlot, UINT16 iAdi, UINT8 bElement, UINT8 bBit )

	** int a ChannelDiagnosis of ExtChannelDiagnosis structure.
	** into a ChannelDiagnosis of ExtChannelDiagnosis structure.

	if( ( ( iChannelProperties & ~(DI_PRT_CHAN_PROP_TYPE_MASK) ) != DI_PRT_CHAN_PROP_TYPE_UNDEF ) &&
	if( ( ( iChannelProperties & DI_PRT_CHAN_PROP_TYPE_MASK ) != DI_PRT_CHAN_PROP_TYPE_UNDEF ) &&

	** Build a 'Create diag. event' command with a "major, recovrable" severity,
	** Build a 'Create diag. event' command with a "major, recoverable" severity,

Conversation

hms-toth commented Feb 13, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant