Generic

Reset (0x0001)

Causes a full system reset. An SDEP response message is sent before the system reset is performed.

  • Command Enum: SDEP_CMD_RESET
  • Command ID: 0x0001
  • Added: Codebase 0.5.0

Parameters: None.

Return Code(s):

  • ERROR_NONE if the command executed properly.

Factory Reset (0x0002)

Performs a factory reset of the device, resetting all config data in non-volatile memory to factory defaults, as well as erasing the Arduino user code area (leaving the bootloader and feather library intact). A system reset will take place once the config data has been set to the default values.

  • Command Enum: SDEP_CMD_FACTORYRESET
  • Command ID: 0x0002
  • Added: Codebase 0.5.0

Parameters: None.

Return Code(s):

  • ERROR_NONE if the command executed properly.

Enter DFU Mode (0x0003)

Causes the board to reset into USB DFU mode.

  • Command Enum: SDEP_CMD_DFU
  • Command ID: 0x0003
  • Added: Codebase 0.5.0

Parameters: None.

Return Code(s):

  • ERROR_NONE if the command executed properly.

System Information (0x0004)

Returns a string or set of comma-separated strings containing basic system information, such as the firmware version, the HW MAC address, compilation date, etc.

  • Command Enum: SDEP_CMD_INFO
  • Command ID: 0x0004
  • Added: Codebase 0.5.0

Parameters:

Parameter ID

This optional parameter allows you to indicate the specific system information value to be returned.

  • Mandatory: No
  • Size: 1 byte
  • Type: uint8_t

The parameter ID can be one of the following values:

  • 1: Board Name: The board family the firmware was built against
  • 2: MCU Name: The target MCU the firmware was built against
  • 3: Serial: The serial string that uniquely identifies this MCU
  • 4: MAC Address: The HW MAC address for the radio interface
  • 5: Bootloader Version: The bootloader version used
  • 6: SDK Version: The SDK version for the Broadcom WICED WiFi stack
  • 7: Codebase Version: The version for the Adafruit Featherlib
  • 8: Firmware Version: Currently the same as codebase version
  • 9: Build Date: The date when the Featherlib was compiled

Response Message

If no Parameter ID value is provided, the complete list of values will be returned as a comma-separated list of strings in incrementing order, starting with 1, 'Board Name'.

If a valid Parameter ID is provided, only the corresponding value will be returned.

Return Code(s)

  • ERROR_NONE if the command executed properly.
  • ERROR_SDEP_INVALIDPARAMETER if an invalid Parameter ID was provided, or an invalid number of parameters is provided.

NVM Reset (0x0005)

Resets all config data stored in non-volatile memory to it's default state.

  • Command Enum: SDEP_CMD_NVM_RESET
  • Command ID: 0x0005
  • Added: Codebase 0.5.0

Parameters: None.

Return Code(s):

  • ERROR_NONE if the command executed properly.

Error String (0x0006)

Returns a string containing the internal name associated with the supplied 32-bit error code.

  • Command Enum: SDEP_CMD_ERROR_STRING
  • Command ID: 0x0006
  • Added: Codebase 0.5.0

Parameters: None.

Error ID

Indicates the specific error code to be converted to it's internal string representation.

  • Mandatory: Yes
  • Size: 4 bytes
  • Type: uint32_t

Response Message:

If a valid error code is provided, a string representing the enum associated with that value will be returned.

Return Code(s):

  • ERROR_NONE if the command executed properly.
  • ERROR_SDEP_INVALIDPARAMETER if an invalid number of parameters is provided.

Generate Random Number (0x0101)

Generates a random 32-bit value using the hardware random number generator on the STM32F2 MCU.

  • Command Enum: SDEP_CMD_RANDOMNUMBER
  • Command ID: 0x0101
  • Added: Codebase 0.5.0

Parameters: None.

Return Code(s):

A 32-bit number generated via the hardware random number generator.

Return Code(s)

  • ERROR_NONE if the command executed properly.
  • ERROR_SDEP_INVALIDPARAMETER if an invalid number of parameters is provided.
This guide was first published on Mar 23, 2016. It was last updated on Oct 18, 2018. This page (Generic) was last updated on Mar 04, 2016.