Class MicropythonFsHex
Implements
- FsInterface
Index
Constructors
Methods
Constructors
constructor
- new MicropythonFsHex(
intelHex: string | IntelHexWithId[],
__namedParameters?: { maxFsSize?: number },
): MicropythonFsHex File System manager constructor.
-At the moment it needs a MicroPython hex string without files included. -Multiple MicroPython images can be provided to generate a Universal Hex.
-Parameters
- intelHex: string | IntelHexWithId[]
MicroPython Intel Hex string or an array of Intel Hex -strings with their respective board IDs.
- - __namedParameters: { maxFsSize?: number } = {}
Returns MicropythonFsHex
- intelHex: string | IntelHexWithId[]
Methods
append
create
exists
get
- getIntelHex(boardId?: number): string
Generate a new copy of the MicroPython Intel Hex with the files in the -filesystem included.
-Parameters
OptionalboardId: numberWhen multiple MicroPython hex files are provided select -one via this argument.
-
Returns string
A new string with MicroPython and the filesystem included.
-
get
- getIntelHexBytes(boardId?: number): Uint8Array
Generate a byte array of the MicroPython and filesystem data.
-Parameters
OptionalboardId: numberWhen multiple MicroPython hex files are provided select -one via this argument.
-
Returns Uint8Array
A Uint8Array with MicroPython and the filesystem included.
-
get
get
get
get
import
- importFilesFromHex(hexStr: string, options?: ImportOptions): string[]
Read the files included in a MicroPython Universal or Intel Hex string and -add them to this instance.
-Parameters
- hexStr: string
MicroPython Intel or Universal Hex string with files.
- - options: ImportOptions = {}
Returns string[]
A filename list of added files.
-- hexStr: string
import
- importFilesFromIntelHex(
intelHex: string,
__namedParameters?: ImportOptions,
): string[] Read the files included in a MicroPython hex string and add them to this -instance.
-Parameters
- intelHex: string
MicroPython hex string with files.
- - __namedParameters: ImportOptions = {}
Returns string[]
A filename list of added files.
-- intelHex: string
import
- importFilesFromUniversalHex(
universalHex: string,
__namedParameters?: ImportOptions,
): string[] Read the files included in a MicroPython Universal Hex string and add them -to this instance.
-Parameters
- universalHex: string
MicroPython Universal Hex string with files.
- - __namedParameters: ImportOptions = {}
Returns string[]
A filename list of added files.
-- universalHex: string
ls
read
read
remove
set
size
write
diff --git a/config/docs/api/enums/microbitBoardId.html b/config/docs/api/enums/microbitBoardId.html
deleted file mode 100644
index 27440e2..0000000
--- a/config/docs/api/enums/microbitBoardId.html
+++ /dev/null
@@ -1,7 +0,0 @@
-
Enumeration microbitBoardId
The Board ID is used to identify the different targets from a Universal Hex.
-In this case the target represents a micro:bit version.
-For micro:bit V1 (v1.3, v1.3B and v1.5) the boardId is 0x9900, and for
-V2 0x9903.
Function addIntelHexAppendedScript
- addIntelHexAppendedScript(intelHex: string, pyCode: string): string
Converts the Python code into the Intel Hex format expected by -MicroPython and injects it into a Intel Hex string containing a marker.
-TODO: Throw error if filesystem is using the penultimate page already.
-Parameters
- intelHex: string
Single string of Intel Hex records to inject the code.
- - pyCode: string
Returns string
Intel Hex string with the Python code injected.
-- intelHex: string
diff --git a/config/docs/api/functions/getHexMapDeviceMemInfo.html b/config/docs/api/functions/getHexMapDeviceMemInfo.html
deleted file mode 100644
index 4180bc2..0000000
--- a/config/docs/api/functions/getHexMapDeviceMemInfo.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
Function getHexMapDeviceMemInfo
- getHexMapDeviceMemInfo(intelHexMap: MemoryMap): DeviceMemInfo
Attempts to retrieve the device memory data from an MicroPython Intel Hex -memory map.
-Parameters
- intelHexMap: MemoryMap
MicroPython Intel Hex memory map to scan.
-
Returns DeviceMemInfo
Device data.
-- intelHexMap: MemoryMap
diff --git a/config/docs/api/functions/getIntelHexDeviceMemInfo.html b/config/docs/api/functions/getIntelHexDeviceMemInfo.html
deleted file mode 100644
index b2cb1e5..0000000
--- a/config/docs/api/functions/getIntelHexDeviceMemInfo.html
+++ /dev/null
@@ -1,4 +0,0 @@
-
Function getIntelHexDeviceMemInfo
- getIntelHexDeviceMemInfo(intelHex: string): DeviceMemInfo
Attempts to retrieve the device memory data from an MicroPython Intel Hex.
-Parameters
- intelHex: string
MicroPython Intel Hex string.
-
Returns DeviceMemInfo
Device data.
-- intelHex: string
diff --git a/config/docs/api/index.html b/config/docs/api/index.html
deleted file mode 100644
index 38bf5f4..0000000
--- a/config/docs/api/index.html
+++ /dev/null
@@ -1,22 +0,0 @@
-
microbit-fs API
micro:bit MicroPython Filesystem
A TypeScript library to manipulate the micro:bit MicroPython filesystem.
-
-Documentation
The docs can be found in -https://microbit-foundation.github.io/microbit-fs/.
-npm Package
To add this package to your project:
-npm install @microbit/microbit-fs
-License
This software is under the MIT open source license.
- -Code of Conduct
Trust, partnership, simplicity and passion are our core values we live and -breathe in our daily work life and within our projects. Our open-source -projects are no exception. We have an active community which spans the globe -and we welcome and encourage participation and contributions to our projects -by everyone. We work to foster a positive, open, inclusive and supportive -environment and trust that our community respects the micro:bit code of -conduct. Please see our code of conduct -which outlines our expectations for all those that participate in our -community and details on how to report any concerns and what would happen -should breaches occur.
-Interface DeviceMemInfo
This interface represents the data about the device target contained within a -MicroPython hex file.
-This data is stored in different formats depending on the MicroPython port, -V1 uses the UICR location, and V2 uses a table stored in flash.
-interface DeviceMemInfo {
deviceVersion: DeviceVersion;
flashEndAddress: number;
flashPageSize: number;
flashSize: number;
flashStartAddress: number;
fsEndAddress: number;
fsStartAddress: number;
runtimeEndAddress: number;
runtimeStartAddress: number;
uPyVersion: string;
}
deviceVersion: DeviceVersion;
flashEndAddress: number;
flashPageSize: number;
flashSize: number;
flashStartAddress: number;
fsEndAddress: number;
fsStartAddress: number;
runtimeEndAddress: number;
runtimeStartAddress: number;
uPyVersion: string;
}
Index
Properties
device
Device targeted by this hex file.
-flash
flashEndAddress: number
End address for the flash memory.
-flash
flashPageSize: number
Size of a single flash page, in bytes.
-flash
flashSize: number
Full flash size in bytes.
-flash
flashStartAddress: number
Start address for the flash memory.
-fs
fsEndAddress: number
End address in flash where the MicroPython filesystem starts.
-fs
fsStartAddress: number
Start address in flash where the MicroPython filesystem starts.
-runtime
runtimeEndAddress: number
End address in flash where the MicroPython runtime starts.
-runtime
runtimeStartAddress: number
Start address in flash where the MicroPython runtime starts.
-u
uPyVersion: string
MicroPython version string.
-Interface ImportOptions
Options for importing Hex files into a MicropythonFsHex instance.
- Index
Properties
Interface IntelHexWithId
Simple interface to pair an Intel Hex string with the board ID it represents.
-microbit-fs API
Enumerations
Classes
Interfaces
Type Aliases
Type Alias DeviceVersion
DeviceVersion: "V1" | "V2"
Represents the micro:bit Version the hex file targets.
-
Manage filesystem files in one or multiple MicroPython hex files.
-