Click or drag to resize

ProductAPI Class

ProductAPI contains the shared functionalities used by GatewayAPI and ModuleAPI like erasing firmware, installing firmware, etc.
Inheritance Hierarchy

Namespace:  Nexpaq.APIs
Assembly:  NexpaqCore (in NexpaqCore.dll) Version: 1.0.6767.24310
Syntax
C#
public abstract class ProductAPI : API

The ProductAPI type exposes the following members.

Constructors
  NameDescription
Public methodProductAPI
Initializes a new instance of ProductAPI.
Top
Methods
  NameDescription
Protected methodBSLInfoReceivedHandler
Handles when product BSL info received
Public methodChangeMode
Changes the mode of product.
Public methodEraseFirmware
Erases the firmware in specified product.
Public methodGetProductByUUID
Gets the product by UUID.
Public methodGetTypeID
Gets the product type identifier from known products or cloud.
Public methodInstallFirmware
Installs the firmware by version.
Public methodInstallLatestFirmware
Installs the latest firmware.
Public methodInstallSpecificFirmware
Installs specific firmware to module, type must be compatible. It is impossible to install MAX firmware to MSP and vice versa.
Public methodRequestBasicData
Requests the basic data from product.
Public methodRequestFirmwareVersion
Requests the firmware version of product.
Public methodSetManifest
Sets the manifest to product.
Protected methodTriggerError (Inherited from ErrorClass.)
Top
Events
  NameDescription
Public eventBSLInfoReceived
occurs when bsl information are received.
Public eventError (Inherited from ErrorClass.)
Public eventFirmwareFlashed
Occurs when firmware was flashed to product.
Top
Fields
  NameDescription
Protected fieldAPI
Main Api.
Protected fieldType
Product type.
Top
See Also