Question: In the context of file-uploading and file-downloading what is the enum type of HasReturnCode.GroupReturnCode.group and .rc?

[ksidirop-laerdal]

https://github.com/NordicSemiconductor/Android-nRF-Connect-Device-Manager/blob/main/mcumgr-core/src/main/java/io/runtime/mcumgr/response/HasReturnCode.java

In our Laerdal.McuMgr bindings-library we need to perform exception-mapping and error-mapping between the Java world and the C# world whenever an error occurs during file-downloading or file-uploading (for example "file not found", "corrupted", etc).

private final class FileDownloaderCallbackProxy implements DownloadCallback
{
        @Override
        public void onDownloadFailed(@NonNull final McuMgrException exception)
        { ...
        }
}

private final class FileUploaderCallbackProxy implements UploadCallback
{
        @Override
        public void onUploadFailed(@NonNull final McuMgrException error)
        {...
        }
}

Is it correct to say that in the context of file-uploading and file-downloading any McuMgrErrorException adheres to the following statements?

exception.getGroupCode().rc (int field)          ->  always adheres to 'enum McuMgrErrorCode' (?)
exception.getGroupCode().group (int field)   ->  always adheres to 'enum FsManager.ReturnCode' (?)

Likewise in the case of firmware-installation we have the following callbacks-proxy:

private final class FirmwareInstallCallbackProxy implements FirmwareUpgradeCallback<FirmwareUpgradeManager.State>
{
        @Override
        public void onUpgradeFailed(final FirmwareUpgradeManager.State state, final McuMgrException ex)
        {   ...
        }
}

Is it correct to say that in the context of firmware-installation any McuMgrErrorException adheres to the following statements?

exception.getGroupCode().rc (int field)          ->  always adheres to 'enum McuMgrErrorCode' (?)
exception.getGroupCode().group (int field)   ->  always adheres to 'enum ImageManager.ReturnCode' (?)

( I just want to be sure that there isn't some corner case where these integer fields are adhering to some other enums because if this happens our error-mapping and exception-mapping will end up mapping and reporting the wrong kind of error over to the C# world misleading the host-application! )

[philips77]

The group is the ID of the manager (group), so that's one of these:

Android-nRF-Connect-Device-Manager/mcumgr-core/src/main/java/io/runtime/mcumgr/McuManager.java

Lines 60 to 76 in 389c600

	// Mcu Manager groups
	protected final static int GROUP_DEFAULT = 0;
	protected final static int GROUP_IMAGE = 1;
	protected final static int GROUP_STATS = 2;
	protected final static int GROUP_SETTINGS = 3;
	protected final static int GROUP_LOGS = 4;
	protected final static int GROUP_CRASH = 5;
	protected final static int GROUP_SPLIT = 6;
	protected final static int GROUP_RUN = 7;
	protected final static int GROUP_FS = 8;
	protected final static int GROUP_SHELL = 9;
	// https://github.com/nrfconnect/sdk-zephyr/blob/master/include/mgmt/mcumgr/zephyr_groups.h
	protected final static int GROUP_BASIC = 63;
	protected final static int GROUP_SUIT = 66; // TODO This should be changed to 62 at some point
	// User defined groups should start from GROUP_PERUSER.
	protected final static int GROUP_PERUSER = 64;

The rc is a the [TheManagerWithGivenGroupId].ReturnCode. So, if exception.getGroupCode().rc == 8 (FSManager), than rc adheres to 'enum FsManager.ReturnCode', etc.

[philips77]

If the device doesn't support SMP v. 2, the exception.getGroupCode() returns null, and you need to use exception.getCode(), which adverse to

Android-nRF-Connect-Device-Manager/mcumgr-core/src/main/java/io/runtime/mcumgr/McuMgrErrorCode.java

Line 24 in 389c600

public enum McuMgrErrorCode {

[ksidirop-laerdal]

Appreciate the prompt response. Now it all makes sense. Just a quick follow up question or two:

1. I tried to track down the return codes for the following groups but I couldn't spot them anywhere in the code base:

int GROUP_LOGS   = 4
int GROUP_CRASH  = 5
int GROUP_SPLIT  = 6
int GROUP_RUN    = 7

2. On the flip-side I've found the BasicManager.ReturnCode enum in the java libraries but I can't see which group it belongs to. Does it have a group-id and if so which one?

Appreciate any insights!

[philips77]

Hi,
Basic Group is called Zephyr Group, as far as I remember. These are Zephyr specific commands, or actually just one, the erase app settings.

The other group you mentioned aren't supported on Zephyr, thus weren't migrated to SMP V2, so they don't support group errors.

[ksidirop-laerdal]

Basic Group is called Zephyr Group, as far as I remember. These are Zephyr specific commands, or actually just one, the erase app settings.

Cool. By the way what is the group-id of the basic-group ("zephyr-group"). Can I find it somewhere?

(pardon me if I'm missing something obvious while reading between the lines)