diff --git a/README.md b/README.md index efe312e..6faa4aa 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,56 @@ In addition to supporting development in C/C++, the runtime is also designed spe | ARM mbed online | http://lancaster-university.github.io/microbit-docs/online-toolchains/#mbed | | yotta | http://lancaster-university.github.io/microbit-docs/offline-toolchains/#yotta | +## microbit-dal Configuration + +To configure the DAL a number options can be modified in `MicroBitConfig.h`, a full list and explanation +can be found in our [documentation](http://lancaster-university.github.io/microbit-docs/advanced/#compile-time-options-with-microbitconfigh). + +Alternately, `yotta` can be used to configure the dal regardless of module/folder structure, through providing a +`config.json` in this directory. + +Here is an example of `config.json` with all available options configured: +```json +{ + "microbit-dal":{ + "bluetooth":{ + "enabled": 1, + "pairing_mode": 1, + "private_addressing": 0, + "open": 0, + "whitelist": 1, + "advertising_timeout": 0, + "tx_power": 0, + "dfu_service": 1, + "event_service": 1, + "device_info_service": 1 + }, + "reuse_sd": 1, + "default_pullmode":"PullDown", + "gatt_table_size": "0x300", + "heap_allocator": 1, + "nested_heap_proportion": 0.75, + "system_tick_period": 6, + "system_components": 10, + "idle_components": 6, + "use_accel_lsb": 0, + "min_display_brightness": 1, + "max_display_brightness": 255, + "display_scroll_speed": 120, + "display_scroll_stride": -1, + "display_print_speed": 400, + "panic_on_heap_full": 1, + "debug": 0, + "heap_debug": 0, + "stack_size":2048, + "sram_base":"0x20000008", + "sram_end":"0x20004000", + "sd_limit":"0x20002000", + "gatt_table_start":"0x20001900" + } +} +``` + ## BBC Community Guidelines [BBC Community Guidelines](https://www.microbit.co.uk/help#sect_cg) diff --git a/config.json b/config.json deleted file mode 100644 index a5f93f7..0000000 --- a/config.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "microbit-dal":{ - "bluetooth":{ - "enabled": 1, - "pairing_mode": 1, - "private_addressing": 0, - "open": 0, - "whitelist": 1, - "advertising_timeout": 0, - "tx_power": 0, - "dfu_service": 1, - "event_service": 1, - "device_info_service": 1 - }, - "reuse_sd": 1, - "gatt_table_size": "0x300", - "heap_allocator": 1, - "nested_heap_proportion": 0.75, - "system_tick_period": 6, - "system_components": 10, - "idle_components": 6, - "use_accel_lsb": 0, - "min_display_brightness": 1, - "max_display_brightness": 255, - "display_scroll_speed": 120, - "display_scroll_stride": -1, - "display_print_speed": 400, - "panic_on_heap_full": 1, - "debug": 0, - "heap_debug": 0, - "stack_size":2048, - "sram_base":"0x20000008", - "sram_end":"0x20004000", - "sd_limit":"0x20002000", - "gatt_table_start":"0x20001900" - } -} diff --git a/module.json b/module.json index 81c9da1..8b1af17 100644 --- a/module.json +++ b/module.json @@ -1,6 +1,6 @@ { "name": "microbit-samples", - "version": "2.0.0-rc3", + "version": "2.0.0-rc4", "description": "The micro:bit runtime common abstraction with examples.", "license": "MIT", "dependencies": {