@microbit/capacitor-community-nordic-dfu 7.0.0-microbit.1

package/dist/docs.json

@@ -0,0 +1,900 @@
+{
+  "api": {
+    "name": "NordicDfuPlugin",
+    "slug": "nordicdfuplugin",
+    "docs": "Defines the plugin for handling Nordic DFU processes.\nIncludes methods to start the DFU process, check permissions, and manage event listeners.",
+    "tags": [
+      {
+        "text": "1.0.0",
+        "name": "since"
+      }
+    ],
+    "methods": [
+      {
+        "name": "startDFU",
+        "signature": "(dfuUpdateOptions: DfuUpdateOptions) => Promise<void | PluginResultError>",
+        "parameters": [
+          {
+            "name": "dfuUpdateOptions",
+            "docs": "Options for the DFU process.",
+            "type": "DfuUpdateOptions"
+          }
+        ],
+        "returns": "Promise<void | PluginResultError>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "dfuUpdateOptions Options for the DFU process."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves on successful completion of the DFU process or rejects with a PluginResultError."
+          },
+          {
+            "name": "example",
+            "text": "const dfuOptions: DfuOptions = {\n  mtu: 23,\n  currentMtu: 23,\n  packetReceiptNotificationsEnabled: false,\n};\n\nconst dfuUpdateOptions: DfuUpdateOptions = {\n  deviceAddress: this.device.deviceId,\n  deviceName: this.device.name,\n  filePath: this.file.path,\n  dfuOptions: dfuOptions,\n};\n\nNordicDfu.startDFU(dfuUpdateOptions).then(\n  () => console.log,\n  (error: PluginResultError) => console.error\n);"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Initiates the DFU process with the specified options.",
+        "complexTypes": [
+          "PluginResultError",
+          "DfuUpdateOptions"
+        ],
+        "slug": "startdfu"
+      },
+      {
+        "name": "checkPermissions",
+        "signature": "() => Promise<PermissionStatus>",
+        "parameters": [],
+        "returns": "Promise<PermissionStatus>",
+        "tags": [
+          {
+            "name": "example",
+            "text": "const request = await NordicDfu.checkPermissions();\nconsole.log(request)"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Check status of permissions needed by the plugin",
+        "complexTypes": [
+          "PermissionStatus"
+        ],
+        "slug": "checkpermissions"
+      },
+      {
+        "name": "requestPermissions",
+        "signature": "() => Promise<PermissionStatus>",
+        "parameters": [],
+        "returns": "Promise<PermissionStatus>",
+        "tags": [
+          {
+            "name": "example",
+            "text": "const request = await NordicDfu.requestPermissions();\nconsole.log(request)"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Request permissions needed by the plugin",
+        "complexTypes": [
+          "PermissionStatus"
+        ],
+        "slug": "requestpermissions"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'DFUStateChanged', handler: (update: DfuUpdate) => void) => Promise<PluginListenerHandle> & PluginListenerHandle",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "The name of the event to listen for",
+            "type": "'DFUStateChanged'"
+          },
+          {
+            "name": "handler",
+            "docs": "The handler function that will be called when the event is fired",
+            "type": "(update: DfuUpdate) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName The name of the event to listen for"
+          },
+          {
+            "name": "param",
+            "text": "handler The handler function that will be called when the event is fired"
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves with a PluginListenerHandle that can be used to remove the listener"
+          },
+          {
+            "name": "example",
+            "text": "NordicDfu.addListener('DFUStateChanged', async (update: DfuUpdate) => {\n  console.log(`DFU: state: ${update.state}, data: ${JSON.stringify(update.data)}`);\n}"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Listen for when the DFU state changes",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "DfuUpdate"
+        ],
+        "slug": "addlistenerdfustatechanged-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "A promise that resolves when all listeners are removed"
+          },
+          {
+            "name": "example",
+            "text": "NordicDfu.removeAllListeners();"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Removes all listeners for the DFUStateChanged event",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "PluginResultError",
+      "slug": "pluginresulterror",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "message",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "DfuUpdateOptions",
+      "slug": "dfuupdateoptions",
+      "docs": "Specifies the options required for initiating the DFU process.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "deviceAddress",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The target device address.\nOn **Android** this is the BLE MAC address.\nOn **iOS** and **web** it is a randomly generated UUID identifier.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "deviceName",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The name of the device",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "filePath",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The path to the firmware file",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "dfuOptions",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The additional options for the DFU process",
+          "complexTypes": [
+            "DfuOptions"
+          ],
+          "type": "DfuOptions"
+        }
+      ]
+    },
+    {
+      "name": "DfuOptions",
+      "slug": "dfuoptions",
+      "docs": "Outlines additional options for configuring the DFU process.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "disableNotification",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Sets whether the progress notification in the status bar should be disabled.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "startAsForegroundService",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Sets whether the progress notification in the status bar should be disabled.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "keepBond",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Sets whether the bond information should be preserver after flashing new application.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "restoreBond",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Sets whether a new bond should be created after the DFU is complete. The old bond\ninformation will be removed before.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "dataObjectDelay",
+          "tags": [
+            {
+              "text": "0",
+              "name": "default"
+            },
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Sets the initial delay (in milliseconds) that the service will wait before sending each data object.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "packetReceiptNotificationsEnabled",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Enables or disables the Packet Receipt Notification (PRN) procedure.\n\nBy default the PRNs are disabled on devices with Android Marshmallow or newer and enabled on\nolder ones.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "packetsReceiptNotificationsValue",
+          "tags": [
+            {
+              "text": "12",
+              "name": "default"
+            },
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "If Packet Receipt Notification procedure is enabled, this method sets the number of packets to be sent before\nreceiving a PRN.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "forceDfu",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Setting force DFU to true will prevent from jumping to the DFU Bootloader\nmode in case there is no DFU Version characteristic (Legacy DFU only!).\nUse this if the DFU operation can be handled by your device running in the application mode.\nThis method is ignored in Secure DFU.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "rebootTime",
+          "tags": [
+            {
+              "text": "0",
+              "name": "default"
+            },
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Sets the time (in milliseconds) required by the device to reboot. The library will wait for this time before\nscanning for the device in bootloader mode.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "scanTimeout",
+          "tags": [
+            {
+              "text": "5000",
+              "name": "default"
+            },
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Sets the scan duration (in milliseconds) when scanning for DFU Bootloader.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "forceScanningForNewAddressInLegacyDfu",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "When this is set to true, the Legacy Buttonless Service will scan for the device advertising\nwith an incremented MAC address, instead of trying to reconnect to the same device.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "disableResume",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "1.4.0",
+              "name": "since"
+            }
+          ],
+          "docs": "This options allows to disable the resume feature in Secure DFU. When the extra value is set to true, the DFU will\nsend Init Packet and Data again, despite the firmware might have been send partially before. By default, without\nsetting this extra, or by setting it to false, the DFU will resume the previously cancelled upload if CRC values\nmatch.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "numberOfRetries",
+          "tags": [
+            {
+              "text": "0",
+              "name": "default"
+            },
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Sets the number of retries that the DFU service will use to complete DFU.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "mtu",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Sets the Maximum Transfer Unit (MTU) value that the Secure DFU service will try to request\nbefore performing DFU. **Available for Android only.**\n\nBy default, value 517 will be used, which is the highest supported y Android. However, as the\nhighest supported MTU by the Secure DFU from SDK 15 (first which supports higher MTU) is 247,\nthe sides will agree on using MTU = 247 instead if the phone supports it (Lollipop or newer device).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "currentMtu",
+          "tags": [
+            {
+              "text": "23",
+              "name": "default"
+            },
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Sets the current MTU value. This method should be used only if the device is already\nconnected and MTU has been requested before DFU service is started. **Available for Android only.**",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "disableMtuRequest",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "1.4.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Disables MTU request. **Available for Android only.**",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "scope",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "This method allows to narrow the update to selected parts from the ZIP, for example\nto allow only application update from a ZIP file that has SD+BL+App. System components scope\ninclude the Softdevice and/or the Bootloader (they can't be separated as they are packed in\na single bin file and the library does not know whether it contains only the softdevice,\nthe bootloader or both) Application scope includes the application only.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "mbrSize",
+          "tags": [
+            {
+              "text": "4096",
+              "name": "default"
+            },
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "This method sets the size of an MBR (Master Boot Record). It should be used only\nwhen updating a file from a HEX file. If you use BIN or ZIP, value set here will\nbe ignored.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "unsafeExperimentalButtonlessServiceInSecureDfuEnabled",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Set this flag to true to enable experimental buttonless feature in Secure DFU. When the\nexperimental Buttonless DFU Service is found on a device, the service will use it to\nswitch the device to the bootloader mode, connect to it in that mode and proceed with DFU.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PermissionStatus",
+      "slug": "permissionstatus",
+      "docs": "Represents the current status of permissions in the plugin.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "notifications",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Indicates the permission state of notifications.",
+          "complexTypes": [
+            "PermissionState"
+          ],
+          "type": "PermissionState"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "DfuUpdate",
+      "slug": "dfuupdate",
+      "docs": "The DFU update object that is passed to the DFUStateChanged event",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "state",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Defines the structure for the DFU update object passed to the DFUStateChanged event.",
+          "complexTypes": [
+            "DfuState"
+          ],
+          "type": "DfuState"
+        },
+        {
+          "name": "data",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The DFU data that is passed to the DfuUpdate object",
+          "complexTypes": [
+            "DfuUpdateData"
+          ],
+          "type": "DfuUpdateData"
+        }
+      ]
+    },
+    {
+      "name": "DfuUpdateData",
+      "slug": "dfuupdatedata",
+      "docs": "Contains data related to the DFU update process, such as progress and speed.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "percent",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The current status of upload (0-99).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "speed",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The current speed in bytes per millisecond.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "avgSpeed",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The average speed in bytes per millisecond.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "currentPart",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The number of parts being sent. In case the ZIP file contains a Soft Device and/or a Bootloader together\nwith the application the SD+BL are sent as part 1, then the service starts again and send the application\nas part 2.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "partsTotal",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The total number of parts.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "duration",
+          "tags": [
+            {
+              "text": "1.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The total time elapsed since the start of the DFU process in milliseconds",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "remainingTime",
+          "tags": [
+            {
+              "text": "1.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The estimated remaining time to the end of the DFU process in milliseconds",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    }
+  ],
+  "enums": [
+    {
+      "name": "DfuState",
+      "slug": "dfustate",
+      "members": [
+        {
+          "name": "DEVICE_CONNECTING",
+          "value": "'DEVICE_CONNECTING'",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The device is currently connecting."
+        },
+        {
+          "name": "DEVICE_CONNECTED",
+          "value": "'DEVICE_CONNECTED'",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The device has successfully connected. **Available for Android only.**"
+        },
+        {
+          "name": "DFU_PROCESS_STARTING",
+          "value": "'DFU_PROCESS_STARTING'",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The DFU process is about to start."
+        },
+        {
+          "name": "DFU_PROCESS_STARTED",
+          "value": "'DFU_PROCESS_STARTED'",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The DFU process has started. **Available for Android only.**"
+        },
+        {
+          "name": "ENABLING_DFU_MODE",
+          "value": "'ENABLING_DFU_MODE'",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The device is enabling DFU mode."
+        },
+        {
+          "name": "DFU_PROGRESS",
+          "value": "'DFU_PROGRESS'",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The DFU process is in progress."
+        },
+        {
+          "name": "VALIDATING_FIRMWARE",
+          "value": "'VALIDATING_FIRMWARE'",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The firmware is currently being validated."
+        },
+        {
+          "name": "DEVICE_DISCONNECTING",
+          "value": "'DEVICE_DISCONNECTING'",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The device is disconnecting."
+        },
+        {
+          "name": "DEVICE_DISCONNECTED",
+          "value": "'DEVICE_DISCONNECTED'",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The device has disconnected. **Available for Android only.**"
+        },
+        {
+          "name": "DFU_COMPLETED",
+          "value": "'DFU_COMPLETED'",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The DFU process has completed successfully."
+        },
+        {
+          "name": "DFU_ABORTED",
+          "value": "'DFU_ABORTED'",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The DFU process has been aborted."
+        },
+        {
+          "name": "DFU_FAILED",
+          "value": "'DFU_FAILED'",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The DFU process has failed."
+        }
+      ]
+    }
+  ],
+  "typeAliases": [
+    {
+      "name": "PermissionState",
+      "slug": "permissionstate",
+      "docs": "",
+      "types": [
+        {
+          "text": "'prompt'",
+          "complexTypes": []
+        },
+        {
+          "text": "'prompt-with-rationale'",
+          "complexTypes": []
+        },
+        {
+          "text": "'granted'",
+          "complexTypes": []
+        },
+        {
+          "text": "'denied'",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}