uicr: Interface members should not be capitalised and add to docs.

microbit-foundation · Feb 22, 2019 · 2cf666c · 2cf666c
1 parent 1990f90
commit 2cf666c
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 23 deletions.
diff --git a/docs/quick-guide.md b/docs/quick-guide.md
@@ -44,3 +44,17 @@ if (microbitFs.isAppendedScriptPresent(finalHexStr)) {
   var pythonCode = microbitFs.getIntelHexAppendedScript(finalHexStr)
 }
 ```
+
+### Read UICR data
+
+```js
+var uicrData = getIntelHexUicrData(IntelHexStr);
+console.log('' + );
+console.log('Flash Page Size:' + uicrData.flashPageSize);
+console.log('Runtime Start Page:' + uicrData.runtimeStartPage);
+console.log('Runtime Start Address:' + uicrData.runtimeStartAddress);
+console.log('Runtime End Used:' + uicrData.runtimeEndUsed);
+console.log('Runtime End Address:' + uicrData.runtimeEndAddress);
+console.log('Version Address:' + uicrData.versionAddress);
+console.log('Version: ' + uicrData.version);
+```
diff --git a/src/__tests__/uicr.spec.ts b/src/__tests__/uicr.spec.ts
@@ -21,17 +21,17 @@ describe('Read MicroPython UICR data.', () => {
 
     const result = getIntelHexUicrData(uPyHexFile);
 
-    expect(result.FlashPageSize).toEqual(expectedPageSize);
-    expect(result.RuntimeStartPage).toEqual(expectedRuntimeStartPage);
-    expect(result.RuntimeStartAddress).toEqual(
+    expect(result.flashPageSize).toEqual(expectedPageSize);
+    expect(result.runtimeStartPage).toEqual(expectedRuntimeStartPage);
+    expect(result.runtimeStartAddress).toEqual(
       expectedRuntimeStartPage * expectedPageSize
     );
-    expect(result.RuntimeEndUsed).toEqual(expectedRuntimeEndPage);
-    expect(result.RuntimeEndAddress).toEqual(
+    expect(result.runtimeEndUsed).toEqual(expectedRuntimeEndPage);
+    expect(result.runtimeEndAddress).toEqual(
       expectedRuntimeEndPage * expectedPageSize
     );
-    expect(result.VersionAddress).toEqual(expectedVersionAddress);
-    expect(result.Version).toEqual(expectedVersion);
+    expect(result.versionAddress).toEqual(expectedVersionAddress);
+    expect(result.version).toEqual(expectedVersion);
   });
 
   it('UICR data without MicroPython magic number', () => {

diff --git a/src/index.ts b/src/index.ts
@@ -1,2 +1,3 @@
 export * from './micropython-appended';
 export * from './micropython-fs-hex';
+export * from './uicr';
diff --git a/src/micropython-fs-builder.ts b/src/micropython-fs-builder.ts
@@ -85,7 +85,7 @@ function getFreeChunks(intelHexMap: MemoryMap): number[] {
  */
 function getStartAddress(intelHexMap: MemoryMap): number {
   const uicrData = getHexMapUicrData(intelHexMap);
-  const startAddress = uicrData.RuntimeEndAddress;
+  const startAddress = uicrData.runtimeEndAddress;
   // Ensure the start address aligns with the page size
   if (startAddress % FLASH_PAGE_SIZE) {
     throw new Error(

diff --git a/src/uicr.ts b/src/uicr.ts
@@ -39,13 +39,13 @@ enum MicropythonUicrAddress {
 
 /** MicroPython data stored in the UICR Customer area. */
 interface MicropythonUicrData {
-  FlashPageSize: number;
-  RuntimeStartPage: number;
-  RuntimeStartAddress: number;
-  RuntimeEndUsed: number;
-  RuntimeEndAddress: number;
-  VersionAddress: number;
-  Version: string;
+  flashPageSize: number;
+  runtimeStartPage: number;
+  runtimeStartAddress: number;
+  runtimeEndUsed: number;
+  runtimeEndAddress: number;
+  versionAddress: number;
+  version: string;
 }
 
 /**
@@ -186,7 +186,7 @@ function getVersionLocation(intelHexMap: MemoryMap): number {
 function getHexMapUicrData(intelHexMap: MemoryMap): MicropythonUicrData {
   const uicrMap = intelHexMap.slice(UICR_UPY_START);
   if (!confirmMagicValue(uicrMap)) {
-    throw new Error('Could not find valid UICR data in Intel Hex data.');
+    throw new Error('Could not find valid MicroPython UICR data.');
   }
   const pageSize: number = getPageSize(uicrMap);
   const startPage: number = getStartPage(uicrMap);
@@ -195,13 +195,13 @@ function getHexMapUicrData(intelHexMap: MemoryMap): MicropythonUicrData {
   const version: string = getStringFromIntelHexMap(intelHexMap, versionAddress);
 
   return {
-    FlashPageSize: pageSize,
-    RuntimeStartPage: startPage,
-    RuntimeStartAddress: startPage * pageSize,
-    RuntimeEndUsed: pagesUsed,
-    RuntimeEndAddress: pagesUsed * pageSize,
-    VersionAddress: versionAddress,
-    Version: version,
+    flashPageSize: pageSize,
+    runtimeStartPage: startPage,
+    runtimeStartAddress: startPage * pageSize,
+    runtimeEndUsed: pagesUsed,
+    runtimeEndAddress: pagesUsed * pageSize,
+    versionAddress,
+    version,
   };
 }