Skip to content

Commit 3a649f5

Browse files
microbit-sammicrobit-sam
authored
Merge pull request #2 from microbit-foundation/open-source
Open source repo
2 parents 492e738 + 9947ae2 commit 3a649f5

File tree

6 files changed

+136
-1
lines changed

6 files changed

+136
-1
lines changed

‎.gitignore

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Built application files
2+
*.apk
3+
*.aar
4+
*.ap_
5+
*.aab
6+
7+
# Files for the ART/Dalvik VM
8+
*.dex
9+
10+
# Java class files
11+
*.class
12+
13+
# Generated files
14+
bin/
15+
gen/
16+
out/
17+
# Uncomment the following line in case you need and you don't have the release build type files in your app
18+
# release/
19+
20+
# Gradle files
21+
.gradle/
22+
build/
23+
24+
# Local configuration file (sdk path, etc)
25+
local.properties
26+
27+
# Proguard folder generated by Eclipse
28+
proguard/
29+
30+
# Log Files
31+
*.log
32+
33+
# Android Studio Navigation editor temp files
34+
.navigation/
35+
36+
# Android Studio captures folder
37+
captures/
38+
39+
# IntelliJ
40+
*.iml
41+
.idea/workspace.xml
42+
.idea/tasks.xml
43+
.idea/gradle.xml
44+
.idea/assetWizardSettings.xml
45+
.idea/dictionaries
46+
.idea/libraries
47+
# Android Studio 3 in .gitignore file.
48+
.idea/caches
49+
.idea/modules.xml
50+
# Comment next line if keeping position of elements in Navigation Editor is relevant for you
51+
.idea/navEditor.xml
52+
53+
# Keystore files
54+
# Uncomment the following lines if you do not want to check your keystore files in.
55+
#*.jks
56+
#*.keystore
57+
58+
# External native build folder generated in Android Studio 2.2 and later
59+
.externalNativeBuild
60+
.cxx/
61+
62+
# Google Services (e.g. APIs or Firebase)
63+
# google-services.json
64+
65+
# Freeline
66+
freeline.py
67+
freeline/
68+
freeline_project_description.json
69+
70+
# fastlane
71+
fastlane/report.xml
72+
fastlane/Preview.html
73+
fastlane/screenshots
74+
fastlane/test_output
75+
fastlane/readme.md
76+
77+
# Version control
78+
vcs.xml
79+
80+
# lint
81+
lint/intermediates/
82+
lint/generated/
83+
lint/outputs/
84+
lint/tmp/
85+
# lint/reports/
86+
87+
# Android Profiling
88+
*.hprof
89+

‎CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
2+
Thanks for looking here! We'd love your help. The micro:bit project is only possible through contributions of companies and individuals around the world.
3+
4+
This project is managed on GitHub, and the best way to contribute is to jump in and fix/file issues.
5+
6+
https://github.com/microbit-foundation/android-partial-flashing-lib
7+
8+
If you're interested in working on any of these items, please file an issue and tag @microbit-sam.

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 Micro:bit Educational Foundation
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# micro:bit Partial Flashing Library for Android
22

3-
This library provides partial flashing capabilities to an Android application. It will process a hex file created in MakeCode and flash only the MakeCode script.
3+
This library provides partial flashing capabilities to an Android application.
44

5+
It will process a hex file created in MakeCode or the Python Editor and flash only the user script.
56
To modularize the code, information is passed to and from the library using Intents.
67

78
## Including the lib in an application
@@ -81,3 +82,11 @@ An example that forwards the information to a React Native app:
8182
8283
...
8384
```
85+
86+
## Partial Flashing Algorithm
87+
88+
More information on the partial flashing algorithm can be found [here](https://github.com/lancaster-university/codal-microbit-v2/blob/master/docs/MemoryMap.md).
89+
90+
## Code of Conduct
91+
92+
When interacting with this repository please follow the Micro:bit Foundation's [Code of Conduct](https://microbit.org/terms-of-use/#the-micro:bit-educational-foundation-code-of-conduct).

‎src/main/java/org/microbit/android/partialflashing/HexUtils.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@
1818
* A Class to manipulate micro:bit hex files
1919
* Focused towards stripping a file down to it's PXT section for use in Partial Flashing
2020
*
21+
* (c) 2017 - 2021, Micro:bit Educational Foundation and contributors
22+
*
23+
* SPDX-License-Identifier: MIT
24+
*
2125
*/
2226

2327
public class HexUtils {

‎src/main/java/org/microbit/android/partialflashing/PartialFlashingBaseService.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@
3030
/**
3131
* A class to communicate with and flash the micro:bit without having to transfer the entire HEX file
3232
* Created by samkent on 07/11/2017.
33+
*
34+
* (c) 2017 - 2021, Micro:bit Educational Foundation and contributors
35+
*
36+
* SPDX-License-Identifier: MIT
3337
*/
3438

3539
// A service that interacts with the BLE device via the Android BLE API.

0 commit comments

Comments
 (0)