Class ESPRMBase

constructor

• new ESPRMBase(): ESPRMBase

• Returns ESPRMBase

StaticESPAppUtilityAdapter

StaticESPLocalControlAdapter

StaticESPLocalDiscoveryAdapter

StaticESPNotificationAdapter

StaticESPOauthAdapter

StaticESPProvisionAdapter

StaticESPStorageAdapter

StaticisLoggingEnabled

StatictransportOrder

Staticconfigure

• configure(config: ESPRMBaseConfig): void

• Configures the ESPRMBase instance with the specified configuration. Validates the configuration and initializes necessary services.

  Parameters

  • config: ESPRMBaseConfig

    The configuration object for the ESPRMBase.

  Returns void

  Throws

  If the configuration is invalid.

StaticcurrentVersion

• currentVersion(): string

• Retrieves the current version of the package.

  Returns string

  The version of the package as a string.

StaticenableLogs

• enableLogs(status: boolean): void

• Sets the logging status for the ESPRMBase SDK.

  Parameters

  • status: boolean

    A boolean indicating whether to enable (true) or disable (false) logging.

  Returns void

StaticgetAuthInstance

• getAuthInstance(): ESPRMAuth

• Creates and retrieves a new instance of the ESPRMAuth class.

  Returns ESPRMAuth

  An instance of the ESPRMAuth class.

  Throws

  If the SDK is not configured.

StaticgetConfig

• getConfig(): Readonly<ESPRMBaseConfig>

• Retrieves the current configuration of the ESPRMBase.

  Returns Readonly<ESPRMBaseConfig>

  The current ESPRMBase configuration object.

StaticgetMQTTHost

• getMQTTHost(): Promise<string>

• Retrieves the MQTT host.

  Returns Promise<string>

  A promise that resolves to the MQTT host.

  Throws

  If the SDK is not configured.

StaticsetAppUtilityAdapter

• setAppUtilityAdapter(adapter: ESPAppUtilityAdapterInterface): void

• Sets the app utility adapter for the SDK.

  Parameters

  • adapter: ESPAppUtilityAdapterInterface

    The app utility adapter implementing ESPAppUtilityAdapterInterface.

  Returns void

StaticsetCustomStorageAdapter

• setCustomStorageAdapter(adapter: ESPRMStorageAdapterInterface): void

• Sets a custom storage adapter for the SDK.

  Parameters

  • adapter: ESPRMStorageAdapterInterface

    The custom storage adapter implementing ESPRMStorageAdapterInterface.

  Returns void

StaticsetLocalControlAdapter

• setLocalControlAdapter(adapter: ESPLocalControlAdapterInterface): void

• Sets the local control adapter for the SDK.

  Parameters

  • adapter: ESPLocalControlAdapterInterface

    The local control adapter implementing ESPLocalControlAdapterInterface.

  Returns void

StaticsetLocalDiscoveryAdapter

• setLocalDiscoveryAdapter(adapter: ESPLocalDiscoveryAdapterInterface): void

• Sets the local discovery adapter for the SDK.

  Parameters

  • adapter: ESPLocalDiscoveryAdapterInterface

    The local discovery adapter implementing ESPLocalDiscoveryAdapterInterface.

  Returns void

StaticsetNotificationAdapter

• setNotificationAdapter(adapter: ESPNotificationAdapterInterface): void

• Sets the notification adapter for the SDK.

  Parameters

  • adapter: ESPNotificationAdapterInterface

    The notification adapter implementing ESPNotificationAdapterInterface.

  Returns void

StaticsetOauthAdapter

• setOauthAdapter(adapter: ESPOauthAdapterInterface): void

• Sets the oauth adapter for the SDK.

  Parameters

  • adapter: ESPOauthAdapterInterface

    The oauth adapter implementing ESPOauthAdapterInterface.

  Returns void

StaticsetProvisioningAdapter

• setProvisioningAdapter(adapter: ESPProvisionAdapterInterface): void

• Sets the provisioning adapter for the SDK.

  Parameters

  • adapter: ESPProvisionAdapterInterface

    The provisioning adapter implementing ESPProvisionAdapterInterface.

  Returns void

StaticsetTransportOrder

• setTransportOrder(transportOrder: ESPTransportMode[]): void

• Sets the order of transport modes.

  This method allows you to specify the preferred order of transport modes (e.g., local, cloud, etc.) that the ESPRMBase instance should use when communicating with nodes devices. The transport modes are tried in the order they are provided until a successful connection is established.

  Parameters

  • transportOrder: ESPTransportMode[]

    An array of transport modes in the preferred order.

  Returns void

  Example

  const transportOrder = [ESPTransportMode.WIFI, ESPTransportMode.BLE];
  espRMBaseInstance.setTransportOrder(transportOrder);
  Copy