factory_configurator_client.h File Reference

This API is for developers only.

You can download the `mbed_cloud_dev_credentials.c` file from the portal and thus, skip running FCU on PC side. The API reads all credentials from the `mbed_cloud_dev_credentials.c` file and stores them in the KCM. RoT, Entropy and Time configurations are not a part of fcc_developer_flow() API. Devices that need to set RoT or Entropy should call `fcc_rot_set()`/`fcc_entropy_set()` APIs before fcc_developer_flow(). If device does not have it's own time configuration and `fcc_time_set()` was not called before fcc_developer_flow(), during fcc_verify_device_configured_4mbed_cloud() certificate time validity will not be checked.

Returns:

FCC_STATUS_SUCCESS in case of success or one of the `fcc_status_e` errors otherwise.

Definition at line 57 of file fcc_dev_flow.c.

Sets Entropy.

If device does not have its own entropy - this function must be called after fcc_init() and prior to any other FCC or KCM functions. This API should be used if device has its own entropy and user wishes to add his own entropy.

Parameters:

buf	The buffer containing the entropy.
buf_size	The size of buf in bytes. Must be exactly FCC_ENTROPY_SIZE.

Returns:

Operation status.

Definition at line 217 of file factory_configurator_client.c.

Sets Factory disabled flag to disable further use of the factory flow.

Returns:

Operation status.

Definition at line 281 of file factory_configurator_client.c.

Finalizes the FCC module.

Finalizes and frees file storage resources.

Returns:

FCC_STATUS_SUCCESS in case of success or one of the `fcc_status_e` errors otherwise.

Definition at line 101 of file factory_configurator_client.c.

The function retrieves pointer to warning and errors structure.

Should be called after fcc_verify_device_configured_4mbed_cloud, when possible warning and errors was stored in the structure. The structure contains data of last fcc_verify_device_configured_4mbed_cloud run.*

Returns:

pointer to fcc_output_info_s structure.

Example:

  void print_fcc_output_info(fcc_output_info_s *output_info)
  {
      fcc_warning_info_s *warning_list = NULL;

      if (output_info != NULL) {
          // Check if there is an error
          if (output_info->error_string_info != NULL) {
              // Print the error string
              printf("fcc output error: %s", output_info->error_string_info);
          }
          // Check if there are warnings
          if (output_info->size_of_warning_info_list > 0) {
              // Set warning_list to point on the head of the list
              warning_list = output_info->head_of_warning_list;

              // Iterate the list
              while (warning_list != NULL) {
                  // Print the warning string
                  printf("fcc output warning: %s", warning_list->warning_info_string);
                  // Move warning_list to point on the next warning in he list
                  warning_list = warning_list->next;
              }
          }
      }
  }

Definition at line 152 of file factory_configurator_client.c.

Initiates the FCC module.

Must be called before any other fcc's APIs. Otherwise relevant error will be returned.

Returns:

FCC_STATUS_SUCCESS in case of success or one of the `fcc_status_e` errors otherwise.

Definition at line 77 of file factory_configurator_client.c.

Returns true if the factory flow was disabled by calling fcc_factory_disable() API, outherwise returns false.

• If the factory flow is already disabled any FCC API(s) will fail.

Parameters:

fcc_factory_disable

An output parameter, will be set to "true" in case factory flow is already disabled, "false" otherwise.

Returns:

FCC_STATUS_SUCCESS in case of success or one of the `fcc_status_e` errors otherwise.

Definition at line 259 of file factory_configurator_client.c.

The function returns status of current session between the FCC and the FCU.

If the returned value is true - the session should be finished in the communication layer after current message processing, if the return value is false - the session should be kept alive for next message.

Returns:

bool

Definition at line 163 of file factory_configurator_client.c.

Sets root of trust If user wishes to set his own root of trust, this function must be called after fcc_init() and fcc_entropy_set() (if user sets his own entropy), and prior to any other FCC or KCM functions.

Parameters:

buf	The buffer containing the root of trust.
buf_size	The size of buf in bytes. Must be exactly FCC_ROT_SIZE.

Returns:

Operation status.

Definition at line 232 of file factory_configurator_client.c.

Cleans from the device all data that was saved during the factory process.

Should be called if the process failed and needs to be executed again.

Returns:

FCC_STATUS_SUCCESS in case of success or one of the `fcc_status_e` errors otherwise.

Definition at line 132 of file factory_configurator_client.c.

Sets device time.

This function will set the device time to what the user provides. Device time must be set in order to enable certificate expiration validations.

Parameters:

time	The device time to set. As epoch time (number of seconds that have elapsed since January 1, 1970)

Returns:

Operation status.

Definition at line 247 of file factory_configurator_client.c.

The function sets bootstrap ca identification and stores it.

Should be called only after storing bootstrap ca certificate on the device.

Returns:

Operation status.

Definition at line 299 of file factory_configurator_client.c.

Verifies that all mandatory fields needed to connect to mbed Cloud are in place on the device.

Should be called in the end of the factory process

Returns:

FCC_STATUS_SUCCESS in case of success or one of the `fcc_status_e` errors otherwise.

Definition at line 170 of file factory_configurator_client.c.