Skip to content

Commit

Permalink
Introduce alpha ref (#232)
Browse files Browse the repository at this point in the history
* update docs

* introduce alpha ref

* update compile targets

* rename mini x into Vx

* separate Dal and Codal ble settings

* update pxt.json descriptions

* add 'neu.md'

* rename libs/mini-X -> libs/vX

* update settings & codal target

* Update userConfig options

* V1 & V2: no pairing, V3 pairing required

* fix typo
  • Loading branch information
Amerlander authored Sep 15, 2023
1 parent 80f3534 commit 7768e1d
Show file tree
Hide file tree
Showing 53 changed files with 182 additions and 34 deletions.
3 changes: 3 additions & 0 deletions docs/alpha-ref.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"appref": "v"
}
2 changes: 1 addition & 1 deletion docs/beta-ref.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"appref": "v"
"appref": "v6.0.18"
}
2 changes: 1 addition & 1 deletion docs/boards/calliope-mini-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ basic.showString("mini 1")
```

```package
mini-1
v1
```
4 changes: 2 additions & 2 deletions docs/boards/calliope-mini-2.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Calliope mini v2

```sim
basic.showString("mini 2")
basic.showString("calliope mini 2")
```

```package
mini-2
v2
```
22 changes: 22 additions & 0 deletions docs/calliope/neu.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Choosing the right template for Calliope mini

No matter which version of Calliope mini you have or whether you’re programming on a mobile device or PC, you can always create a **`|New Project|`** and start programming.

If you’re using a Calliope mini 2, we suggest to use the optimized template **`|input:Calliope mini 2.x|`**. This allows you to transfer programs faster via Bluetooth and create more complex programs, due to partial flashing and a full usage of the available RAM. The settings loaded with the **`|input:Calliope mini 2.x|`** template can also be activated in any existing project through the settings menu.

If you encounter issues with the default template (**`|functions:Calliope mini 1.x|`** or **`|New Project|`**) and your Calliope mini freezes, it may be due to limited available program memory (RAM). To free up more memory for your program we suggest switching on “Manual Bluetooth activation”. In this case each time you transfer programs you have to set the Calliope mini into Bluetooth mode. To do this, perform the “brace grip”: hold down buttons **`A`** and **`B`**, briefly tap the **`Reset`** button, and continue holding **`A`** and **`B`** until the pattern appears on the LED matrix.

## Additional Notes for iOS Users:

**We recommend that every user of the Calliope mini 2.x updates their device with the Demo Program once.**

If you have previously programmed your Calliope mini with another editor or flashed it with the last **`|input:Calliope mini 2.x|`** template, you cannot transfer the default project template directly from mobile. The Bluetooth settings have changed in this template, so one of the following steps is necessary so that you can transfer your program to mobile devices without any problems:

### Option A: Load program 25 (Demo Program):
To load the Program with the number **`25`** onto your Calliope mini, follow these steps:
1. Press and hold the reset button on your Calliope mini for approximately 5 seconds until all LEDs briefly light up and then turn off.
2. Press the **`A`** button to go back one step. This will illuminate the 25th LED on the display.
3. Press the **`A`** and **`B`** buttons simultaneously to confirm your selection and load Program 25. This process also resolves any other transfer issues. Once completed, your Calliope mini will be restored to its default state.

### Option B: Load the Demo Program:
In the Calliope mini app, navigate to the **`Editors and Programs`** section and locate the **`Start Program`** option. Load this program onto your Calliope mini, and you’ll be able to use the standard project template without any concerns.
6 changes: 6 additions & 0 deletions docs/calliope/templates/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Boards

* [Calliope](/boards/calliope)
* [Calliope mini Ref. 1.x](/boards/calliope-mini-v1)
* [Calliope mini Ref. 2](/boards/calliope-mini-v2)

12 changes: 12 additions & 0 deletions docs/calliope/templates/calliope-mini-1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Calliope mini v1

```blocks
basic.showString("Hi!")
basic.forever(function () {
})
```

```package
core
```
12 changes: 12 additions & 0 deletions docs/calliope/templates/calliope-mini-2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Calliope mini v2

```blocks
basic.showString("Hi!")
basic.forever(function () {
})
```

```package
mini2
```
Binary file added docs/calliope/templates/info.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/calliope/templates/info_L.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions docs/calliope/templates/new-project-pxt4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Calliope

## mini

### ~ codecard

* name: Calliope mini 2.x
* url: /calliope/templates/calliope-mini-2
* cardType: template
* imageUrl: /calliope/templates/32KB.png
* description: Project template for all Calliope mini 2.x

---

* name: Calliope mini 1.x
* url: /calliope/templates/calliope-mini-1
* cardType: template
* imageUrl: /calliope/templates/16KB.png
* description: Project template for all Calliope mini 1.x

---

* name: Which template?
* url: /calliope/neu
* imageUrl: /calliope/templates/info.png
* description: Not sure which template is right for you? Here you will find the necessary information.

### ~
39 changes: 38 additions & 1 deletion libs/core-mini-codal/pxt.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,42 @@
"soundexpressions.ts",
"playable.ts",
"rgbled.ts"
]
],
"yotta": {
"optionalConfig": {
"microbit-dal": {
"bluetooth": {
"open": 0,
"security_level": "SECURITY_MODE_ENCRYPTION_NO_MITM",
"whitelist": 1
}
}
},
"userConfigs": [
{
"description": "Bluetooth: No pairing required (Calliope mini 1 and Calliope mini 2 behaviour)",
"config": {
"microbit-dal": {
"bluetooth": {
"open": 1,
"security_level": null,
"whitelist": 0
}
}
}
},
{
"description": "Bluetooth: Paring required (Calliope mini 3 default. Fixes Android 13 bug »GATT ERROR 133«, mini must be already flashed with this option)",
"config": {
"microbit-dal": {
"bluetooth": {
"open": 0,
"security_level": "SECURITY_MODE_ENCRYPTION_NO_MITM",
"whitelist": 1
}
}
}
}
]
}
}
39 changes: 38 additions & 1 deletion libs/core-mini-dal/pxt.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,42 @@
"motors.ts",
"parts/dcmotor.svg",
"input.cpp"
]
],
"yotta": {
"optionalConfig": {
"microbit-dal": {
"bluetooth": {
"open": 1,
"security_level": null,
"whitelist": 0
}
}
},
"userConfigs": [
{
"description": "Bluetooth: No pairing required (default)",
"config": {
"microbit-dal": {
"bluetooth": {
"open": 1,
"security_level": null,
"whitelist": 0
}
}
}
},
{
"description": "Bluetooth: Paring required (fixes Android 13 »GATT ERROR 133«-Bug, mini must be already flashed with this option)",
"config": {
"microbit-dal": {
"bluetooth": {
"open": 0,
"security_level": "SECURITY_MODE_ENCRYPTION_NO_MITM",
"whitelist": 1
}
}
}
}
]
}
}
15 changes: 0 additions & 15 deletions libs/core/pxt.json
Original file line number Diff line number Diff line change
Expand Up @@ -114,9 +114,6 @@
"event_service": 0,
"device_info_service": 1,
"private_addressing": 0,
"open": 1,
"security_level": null,
"whitelist": 0,
"advertising_timeout": 0,
"tx_power": 6
},
Expand Down Expand Up @@ -147,18 +144,6 @@
}
}
}
},
{
"description": "Bluetooth: Require Pariring (Solves an Android 13+ bug)",
"config": {
"microbit-dal": {
"bluetooth": {
"open": 0,
"security_level": "SECURITY_MODE_ENCRYPTION_NO_MITM",
"whitelist": 1
}
}
}
}
]
}
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
4 changes: 2 additions & 2 deletions libs/mini-1/pxt.json → libs/v1/pxt.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "mini-1",
"name": "v1",
"version": "1.0.0",
"description": "The calliope mini 1 core library",
"description": "Calliope mini 1",
"compileServiceVariant": "minidal",
"disablesVariants": [
"minicodal"
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
4 changes: 2 additions & 2 deletions libs/mini-2/pxt.json → libs/v2/pxt.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "mini-2",
"name": "v2",
"version": "1.0.0",
"description": "The calliope mini 2 core library",
"description": "Calliope mini 2",
"compileServiceVariant": "minidal",
"disablesVariants": [
"minicodal"
Expand Down
File renamed without changes.
1 change: 1 addition & 0 deletions libs/v3/_locales/V3-jsdoc-strings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
1 change: 1 addition & 0 deletions libs/v3/_locales/V3-strings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
1 change: 1 addition & 0 deletions libs/v3/_locales/mini-3-jsdoc-strings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
1 change: 1 addition & 0 deletions libs/v3/_locales/mini-3-strings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
1 change: 1 addition & 0 deletions libs/v3/_locales/mini-v3-jsdoc-strings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
1 change: 1 addition & 0 deletions libs/v3/_locales/mini-v3-strings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
File renamed without changes.
File renamed without changes
File renamed without changes
4 changes: 2 additions & 2 deletions libs/mini-3/pxt.json → libs/v3/pxt.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "mini-3",
"description": "The calliope mini 3 core library",
"name": "v3",
"description": "Calliope mini 3",
"core": true,
"compileServiceVariant": "minicodal",
"disablesVariants": [
Expand Down
12 changes: 6 additions & 6 deletions pxtarget.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
"libs/core-mini",
"libs/core-mini-dal",
"libs/core-mini-codal",
"libs/mini-1",
"libs/mini-2",
"libs/v1",
"libs/v2",
"libs/radio",
"libs/devices",
"libs/bluetooth",
Expand Down Expand Up @@ -147,9 +147,9 @@
"yottaTarget": "calliope-mini-classic-gcc@https://github.com/calliope-mini/target-calliope-mini-classic-gcc#v1.2.4",
"yottaCorePackage": "microbit",
"githubCorePackage": "calliope-mini/microbit",
"gittag": "master-iss",
"gittag": "v2.2.0-rc6-calliope1.1",
"serviceId": "calliope",
"dockerImage": "pext/yotta:update-yotta3"
"dockerImage": "pext/yotta:gcc5"
},
"variants": {
"minidal": {
Expand All @@ -171,14 +171,14 @@
"codalTarget": {
"name": "codal-microbit-v2",
"url": "https://github.com/calliope-edu/codal-microbit-v2",
"branch": "v0.2.57-calliope",
"branch": "v0.2.57-calliope-1.4",
"type": "git"
},
"codalBinary": "MICROBIT",
"githubCorePackage": "calliope-edu/microbit-v2-samples",
"gittag": "v0.2.13-calliope",
"serviceId": "mbcodal2",
"dockerImage": "pext/yotta:update-yotta3",
"dockerImage": "pext/yotta:latest",
"yottaConfigCompatibility": true
}
}
Expand Down
2 changes: 1 addition & 1 deletion targetconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@
"preferred": true
},
"calliope-edu/pxt-jacdac": {
"tags": [ "jacdac", "mini 3" ],
"tags": [ "jacdac", "V3" ],
"preferred": true
}
},
Expand Down

0 comments on commit 7768e1d

Please sign in to comment.