Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
virtualabs committed Aug 21, 2018
1 parent 2d05735 commit 4964f3f
Showing 1 changed file with 14 additions and 50 deletions.
64 changes: 14 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@

This repository contains the firmware source code used by Btlejack to communicate and attack BLE connections with Micro:Bit devices.

Two versions of this firmware can be compiled:

* a version for the BBC Micro:Bit
* a version for BLE400 and Adafruit's Bluefruit LE boards

To compile these two versions:

```
$ make all
```

Firmware hex files are then available in the `dist` directory (not versioned).


## Links

[micro:bit runtime docs](http://lancaster-university.github.io/microbit-docs/) | [microbit-dal](https://github.com/lancaster-university/microbit-dal) | [uBit](https://github.com/lancaster-university/microbit)
Expand All @@ -13,56 +27,6 @@ This repository contains the firmware source code used by Btlejack to communicat
| 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

The DAL also contains a number of compile time options can be modified. 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)

0 comments on commit 4964f3f

Please sign in to comment.