namespace ZB.MOM.WW.OtOpcUa.Driver.AbCip;
///
/// Maps libplctag / CIP General Status codes to OPC UA StatusCodes. Mirrors the shape of
/// ModbusDriver.MapModbusExceptionToStatus so Admin UI status displays stay
/// uniform across drivers.
///
///
/// Coverage: the CIP general-status values an AB PLC actually returns during normal
/// driver operation. Full CIP Volume 1 Appendix B lists 50+ codes; the ones here are the
/// ones that move the driver's status needle:
///
/// - 0x00 success — OPC UA Good (0).
/// - 0x04 path segment error / 0x05 path destination unknown — BadNodeIdUnknown
/// (tag doesn't exist).
/// - 0x06 partial data transfer — GoodMoreData (fragmented read underway).
/// - 0x08 service not supported — BadNotSupported (e.g. write on a safety
/// partition tag from a non-safety task).
/// - 0x0A / 0x13 attribute-list error / insufficient data — BadOutOfRange
/// (type mismatch or truncated buffer).
/// - 0x0B already in requested mode — benign, treated as Good.
/// - 0x0E attribute not settable — BadNotWritable.
/// - 0x10 device state conflict — BadDeviceFailure (program-mode protected
/// writes during download / test-mode transitions).
/// - 0x16 object does not exist — BadNodeIdUnknown.
/// - 0x1E embedded service error — unwrap to the extended status when possible.
/// - any libplctag PLCTAG_STATUS_* below zero — wrapped as
/// BadCommunicationError until fine-grained mapping lands (PR 3).
///
///
public static class AbCipStatusMapper
{
public const uint Good = 0u;
public const uint GoodMoreData = 0x00A70000u;
public const uint BadInternalError = 0x80020000u;
public const uint BadNodeIdUnknown = 0x80340000u;
public const uint BadNotWritable = 0x803B0000u;
public const uint BadOutOfRange = 0x803C0000u;
public const uint BadNotSupported = 0x803D0000u;
public const uint BadDeviceFailure = 0x80550000u;
public const uint BadCommunicationError = 0x80050000u;
public const uint BadTimeout = 0x800A0000u;
public const uint BadTypeMismatch = 0x80730000u;
/// Map a CIP general-status byte to an OPC UA StatusCode.
public static uint MapCipGeneralStatus(byte status) => status switch
{
0x00 => Good,
0x04 or 0x05 => BadNodeIdUnknown,
0x06 => GoodMoreData,
0x08 => BadNotSupported,
0x0A or 0x13 => BadOutOfRange,
0x0B => Good,
0x0E => BadNotWritable,
0x10 => BadDeviceFailure,
0x16 => BadNodeIdUnknown,
_ => BadInternalError,
};
///
/// Map a libplctag return/status code (PLCTAG_STATUS_*) to an OPC UA StatusCode.
/// libplctag uses 0 = PLCTAG_STATUS_OK, positive values for pending, negative
/// values for errors.
///
public static uint MapLibplctagStatus(int status)
{
if (status == 0) return Good;
if (status > 0) return GoodMoreData; // PLCTAG_STATUS_PENDING
return status switch
{
-5 => BadTimeout, // PLCTAG_ERR_TIMEOUT
-7 => BadCommunicationError, // PLCTAG_ERR_BAD_CONNECTION
-14 => BadNodeIdUnknown, // PLCTAG_ERR_NOT_FOUND
-16 => BadNotWritable, // PLCTAG_ERR_NOT_ALLOWED / read-only tag
-17 => BadOutOfRange, // PLCTAG_ERR_OUT_OF_BOUNDS
_ => BadCommunicationError,
};
}
}