ModuleAPI Class |
ModuleAPI is responsible for performing module related operations like sending commands to modules and initializing modules.
Inheritance HierarchyNamespace: Nexpaq.APIs
Assembly: NexpaqCore (in NexpaqCore.dll) Version: 1.0.6767.24310
SyntaxC#
public class ModuleAPI : ProductAPI
The ModuleAPI type exposes the following members.
ConstructorsMethods| Name | Description | |
|---|---|---|
 | BSLInfoReceivedHandler |
Handles when product BSL info received
(Inherited from ProductAPI.) |
 | ChangeMode |
Changes the mode of product.
(Inherited from ProductAPI.) |
| EraseFirmware |
Erases the firmware in specified product.
(Inherited from ProductAPI.) |
| GetByUUID |
Gets the module by UUID.
|
| GetProductByUUID |
Gets the product by UUID.
(Overrides ProductAPIGetProductByUUID(UUID).) |
| GetTypeID |
Gets the product type identifier from known products or cloud.
(Inherited from ProductAPI.) |
| GetUUIDBySlot |
Gets the UUID of module by slot.
|
| InitializeModule |
Initializes the module and requests all it's data.
|
| InstallFirmware |
Installs the firmware by version.
(Inherited from ProductAPI.) |
| InstallLatestFirmware |
Installs the latest firmware.
(Inherited from ProductAPI.) |
| InstallSpecificFirmware |
Installs specific firmware to module, type must be compatible.
It is impossible to install MAX firmware to MSP and vice versa.
(Inherited from ProductAPI.) |
| PairByName | |
| RequestBasicData |
Requests the basic data from product.
(Inherited from ProductAPI.) |
| RequestFirmwareVersion |
Requests the firmware version of product.
(Inherited from ProductAPI.) |
| SendCommand |
Sends the command to module, using module driver.
|
| SendRawCommand |
Sends the raw command to module.
|
| SendRawHexCommand |
Sends the raw command to module with data in hex.
|
| SetManifest |
Sets the manifest to product.
(Inherited from ProductAPI.) |
| TriggerError | (Inherited from ErrorClass.) |
Events| Name | Description | |
|---|---|---|
 | AllInfoReceived |
Occurs when all module information received
|
| BasicInfoReceived |
Occurs when basic data for the module received.
|
| BatteryStateReceived |
Occurs when battery state received for the module.
|
| BSLInfoReceived |
occurs when bsl information are received.
(Inherited from ProductAPI.) |
| DataReceived |
Occurs when data received from module.
|
| Error | (Inherited from ErrorClass.) |
| FirmwareFlashed |
Occurs when firmware was flashed to product.
(Inherited from ProductAPI.) |
| FirmwareUpdateAvailable |
Occurs when firmware update available.
|
| Inserted |
Occurs when module inserted.
|
| ManifestSet |
Occurs when manifest set.
|
| Pulled |
Occurs when module pulled out.
|
| RawDataReceived |
Occurs when raw data from module received without being processed with module driver.
|
| TypeRecognised |
Occurs when module type recognised.
|
| UUIDRecieved |
Occurs when module UUID recieved.
|
Fields| Name | Description | |
|---|---|---|
 | API |
Main Api.
(Inherited from ProductAPI.) |
| Type |
Product type.
(Inherited from ProductAPI.) |
See Also