Trust Center Backup#

API and Callbacks for the Trust Center Backup Component.

This component is only for a trust center. It provides a set of APIs for importing and exporting the backup info for a Smart Energy trust center. It requires extending to hook up import/export routines into an external storage device or network, where the data may be saved to and restored from.

API#

EmberStatus
emberTrustCenterExportBackupData(EmberAfTrustCenterBackupData *backup)

export backup data

EmberStatus
emberTrustCenterImportBackupAndStartNetwork(const EmberAfTrustCenterBackupData *backup)

Import backup and start network.

EmberStatus
emberAfTrustCenterImportBackupFromFile(const char *filepath)

Import backup from file.

EmberStatus
emberAfTrustCenterExportBackupToFile(const char *filepath)

export backup to a file

EmberStatus
emberAfTrustCenterBackupSaveTokensToFile(const char *filepath)

saves tokens to a file

EmberStatus
emberAfTrustCenterBackupRestoreTokensFromFile(const char *filepath)

restores tokens from a file

EmberStatus
emberAfTrustCenterBackupWriteNcpTokenToZigbeedTokens(const char *filepath)

Updates zigbeed tokens from a file that stores NCP tokens.

API Documentation#

emberTrustCenterExportBackupData#

EmberStatus emberTrustCenterExportBackupData (EmberAfTrustCenterBackupData * backup)

export backup data

Parameters
N/Abackup

Ver.: always

Returns

  • EmberStatus status code


Definition at line 59 of file app/framework/plugin/trust-center-backup/trust-center-backup.h

emberTrustCenterImportBackupAndStartNetwork#

EmberStatus emberTrustCenterImportBackupAndStartNetwork (const EmberAfTrustCenterBackupData * backup)

Import backup and start network.

Parameters
N/Abackup

Ver.: always

Returns

  • EmberStatus status code


Definition at line 68 of file app/framework/plugin/trust-center-backup/trust-center-backup.h

emberAfTrustCenterImportBackupFromFile#

EmberStatus emberAfTrustCenterImportBackupFromFile (const char * filepath)

Import backup from file.

Parameters
N/Afilepath

Ver.: always

Returns

  • EmberStatus status code

Note

  • Available only for EMBER_AF_PLUGIN_TRUST_CENTER_BACKUP_POSIX_FILE_BACKUP_SUPPORT


Definition at line 79 of file app/framework/plugin/trust-center-backup/trust-center-backup.h

emberAfTrustCenterExportBackupToFile#

EmberStatus emberAfTrustCenterExportBackupToFile (const char * filepath)

export backup to a file

Parameters
N/Afilepath

Ver.: always

Returns

  • EmberStatus status code

Note

  • Available only for EMBER_AF_PLUGIN_TRUST_CENTER_BACKUP_POSIX_FILE_BACKUP_SUPPORT


Definition at line 90 of file app/framework/plugin/trust-center-backup/trust-center-backup.h

emberAfTrustCenterBackupSaveTokensToFile#

EmberStatus emberAfTrustCenterBackupSaveTokensToFile (const char * filepath)

saves tokens to a file

Parameters
N/Afilepath

Ver.: always

Returns

  • EmberStatus status code

Note

  • Available only for EMBER_AF_PLUGIN_TRUST_CENTER_BACKUP_POSIX_FILE_BACKUP_SUPPORT


Definition at line 101 of file app/framework/plugin/trust-center-backup/trust-center-backup.h

emberAfTrustCenterBackupRestoreTokensFromFile#

EmberStatus emberAfTrustCenterBackupRestoreTokensFromFile (const char * filepath)

restores tokens from a file

Parameters
N/Afilepath

Ver.: always

Returns

  • EmberStatus status code

Note

  • Available only for EMBER_AF_PLUGIN_TRUST_CENTER_BACKUP_POSIX_FILE_BACKUP_SUPPORT


Definition at line 112 of file app/framework/plugin/trust-center-backup/trust-center-backup.h

emberAfTrustCenterBackupWriteNcpTokenToZigbeedTokens#

EmberStatus emberAfTrustCenterBackupWriteNcpTokenToZigbeedTokens (const char * filepath)

Updates zigbeed tokens from a file that stores NCP tokens.

Parameters
N/Afilepath

Ver.: always

Returns

  • EmberStatus status code

Note

  • Available only for EMBER_AF_PLUGIN_TRUST_CENTER_BACKUP_POSIX_FILE_BACKUP_SUPPORT


Definition at line 123 of file app/framework/plugin/trust-center-backup/trust-center-backup.h