Skip to content

Update CMSIS/RTX docs #276

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1,773 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1773 commits
Select commit Hold shift + click to select a range
d7c0391
Fix headings in blinky_cli.md
Sep 23, 2017
49cf05d
Fix headings in blinky_compiler.md
Sep 23, 2017
fb78400
Fix headings in oc_tut.md
Sep 23, 2017
f3f3093
Fix headings in oc_pur_tut.md
Sep 23, 2017
51fe5b0
Fix heading in compiler_publishing_code.md
Sep 23, 2017
1556340
Fix headings in compiler_multiple_authors.md
Sep 23, 2017
f74df74
Fix headings in debug_microbit.md
Sep 23, 2017
5d59f48
Fix headings in debug_with_printf.md
Sep 23, 2017
cf557d1
Fix headings in eclipse_pyocd.md
Sep 23, 2017
42106f9
Fix headings in keil_uvision.md
Sep 23, 2017
56a6acc
Fix headings in vs_code.md
Sep 23, 2017
1e26a1f
Update docs.json
Sep 23, 2017
df79533
Fix headings in serial_communication.md
Sep 23, 2017
45d1675
Fix headings in serial_driver.md
Sep 23, 2017
13187f0
Fix headings in http_server.md
Sep 23, 2017
785c28c
Fix headings in flow_control.md
Sep 23, 2017
0bd8696
Fix headings in events_tutorial.md
Sep 23, 2017
e994961
Fix heading in ble_tutorial.md
Sep 23, 2017
9634809
Fix heading in cellular_tcp.md
Sep 23, 2017
34c5776
Fix headings in quick_start_intro.md
Sep 23, 2017
861d452
Update and rename communicating_with_platform.md to serial-overview.md
Sep 23, 2017
2a2b6dd
Update docs.json
Sep 23, 2017
9b8955e
Fix links in how_to_api.md
Sep 24, 2017
972cf17
Fix links in networksocket.md
Sep 24, 2017
734260d
Fix link in MeshInterface.md
Sep 24, 2017
7ed7813
Update CellularInterface.md
Sep 24, 2017
98c0680
Fix typo in storage.md
Sep 24, 2017
5572910
Add more chapters to docs.json
Sep 24, 2017
335b87b
Fix headings in greentea.md
Sep 24, 2017
966e220
Fix headings in Introduction.md
Sep 24, 2017
55529bf
Fix headings in storage.md
Sep 24, 2017
fe8ab9a
Delete heading from contributing.md
Sep 24, 2017
99818b2
Update docs.json
Sep 25, 2017
f222a9f
Fix link in BlockDevice.md
Sep 25, 2017
ec20068
Delete space in BlockDevice.md
Sep 25, 2017
7febf61
Fix links in FileSystem.md
Sep 25, 2017
cae6596
Fix links in MeshInterface.md
Sep 25, 2017
162a3f4
Fix link in BLE.md
Sep 25, 2017
0a555ba
Fix heading in quick_start_hw.md
Sep 25, 2017
2177fa0
Fix heading in quick_start_build.md
Sep 25, 2017
cc39d49
Fix heading in thread_intro.md
Sep 25, 2017
70fad0c
Fix heading in thread_faq.md
Sep 25, 2017
be0fa00
Fix heading in thread_commissioning.md
Sep 25, 2017
69c78ad
Fix heading in 16_contributing_MAC.md
Sep 25, 2017
02d0b7e
Fix heading in 16_API_contributing.md
Sep 25, 2017
d6c6282
Fix heading in 04_N_networking.md
Sep 25, 2017
cca5264
Fix heading in 02_N_arch.md
Sep 25, 2017
a6934aa
Shorten title of flow_control.md
Sep 25, 2017
a937549
Fix headings in CellularInterface.md
Sep 25, 2017
4f668bf
mbed > Mbed
Sep 25, 2017
a6d8290
Adding headers and removing placeholder
Sep 25, 2017
5325dd0
Fix link in introduction.md
Sep 25, 2017
b483e9e
Fixing header levels
Sep 25, 2017
32fb5dd
Maybe it was this?
Sep 25, 2017
91b099d
Update export_to_third_party.md
Sep 25, 2017
ce81428
Fix headings in BlockDevice.md
Sep 25, 2017
caf19ab
Fix heading in FileSystem.md
Sep 25, 2017
2c700ec
Update terms.md
Sep 25, 2017
6fe060c
Fix Ethernet typo
mbartling Sep 25, 2017
353b16c
Merge pull request #268 from mbartling/eth-typo-fix
Sep 25, 2017
6c46864
Add updated image.
Sep 25, 2017
ddb3b91
Fix image in introduction.md
Sep 25, 2017
b5179da
Fix image in reference.md
Sep 25, 2017
825d991
Turn developer.mbed.org to os.mbed.com
Sep 25, 2017
70d1ca1
Fix unbold letters
Sep 25, 2017
f4ab168
Fix headings in introduction.md
Sep 25, 2017
3686829
Standardize heading in online.md
Sep 25, 2017
7a89e17
Standardize title in offline.md
Sep 25, 2017
b77cc6e
Shorten title in debug_builds_cli.md
Sep 25, 2017
a400dc7
Fix title of compiler_collab.md
Sep 25, 2017
80bba28
Make changes from PR #251
Sep 25, 2017
34abc86
Merge pull request #270 from ARMmbed/AnotherButler-patch-2
Sep 25, 2017
e59e222
Rename section in cli.md
Sep 25, 2017
a63518c
Change headings in cli.md
Sep 25, 2017
28b723b
Fix heading in cli.md
Sep 25, 2017
8365b05
Create cli-setup.md
Sep 25, 2017
d5e08cd
Create cli-create.md
Sep 25, 2017
98d295c
Create cli-collaborate.md
Sep 25, 2017
4a95074
Create cli-test-debug.md
Sep 25, 2017
41c267f
Remove sections from cli.md
Sep 25, 2017
7a560eb
Update docs.json
Sep 25, 2017
4ed5804
Fix headings in cli-test-debug.md
Sep 25, 2017
4e2f1bf
Fix heading in cli-collaborate.md
Sep 25, 2017
dc5aa46
Fix headings in cli-create.md
Sep 25, 2017
ae5a9ba
Delete cli_collaboration.md
Sep 25, 2017
3c22eac
Fix heading level in cli.md
Sep 25, 2017
6a5c5ce
Fix headings in introduction.md
Sep 25, 2017
2e1dfef
Update docs.json
Sep 25, 2017
8095d93
Fix heading introduction.md
Sep 25, 2017
79cd4a7
Fix headings in compiler_pull_requests.md
Sep 25, 2017
74e3b69
Fix link in tools_intro.md
Sep 25, 2017
29b9405
Fix link in tools_intro.md
Sep 25, 2017
8428145
Update docs.json
Sep 25, 2017
c304546
Fix headings in mbed_targets.md
Sep 25, 2017
be5f939
Fix headings in config_system.md
Sep 25, 2017
0a42d20
Fix links in config_system.md
Sep 25, 2017
530882f
Delete from compiler_collab.md
Sep 25, 2017
35ed7d8
Fix link in compiler_pull_requests.md
Sep 25, 2017
c6b7459
Fix link in compiler_version_control.md
Sep 25, 2017
98ffa83
Fix links in cli-create.md
Sep 25, 2017
7286ff6
Fix linked text
Sep 25, 2017
abb512d
Fix formatting in mbedignore.md
Sep 25, 2017
48fb22b
Fix links in build_profiles.md
Sep 25, 2017
0a317e2
Fix links in debug_builds_cli.md
Sep 25, 2017
c13ae5c
Delete irrelevant information
Sep 25, 2017
90ce0c7
Fix link in exporters.md
Sep 25, 2017
391ad46
Fix link in debug_intro.md
Sep 26, 2017
bd95a35
Fix links
Sep 26, 2017
25c856a
Fix links
Sep 26, 2017
d83e510
Fix links
Sep 26, 2017
bed61d2
Fix link in DAP.md
Sep 26, 2017
d1e503f
Fix links in testing.md
Sep 26, 2017
930a6bc
Fix link in greentea.md
Sep 26, 2017
daad164
Fix link in utest.md
Sep 26, 2017
779c67d
Fix headings in introduction.md
Sep 26, 2017
b9b74d3
Fix headings in introduction.md
Sep 26, 2017
e79bcbc
Fix link in terms.md
Sep 26, 2017
5b05222
Fix link in DeepSleepLock.md
Sep 26, 2017
4eb0f5c
Fix heading in first_program.md
Sep 26, 2017
538d230
Fix link in Bootstrap.md
Sep 26, 2017
67f53e9
Fix headings in tools_intro.md
Sep 26, 2017
fe6a623
Fix headings in config_system.md
Sep 26, 2017
dd96b37
Fixing links
Sep 26, 2017
3436c98
Also changing order to match ToC
Sep 26, 2017
c4c3852
Minor changes
Sep 26, 2017
1592bbb
That broke the page
Sep 26, 2017
e967029
Revert "That broke the page"
Sep 26, 2017
b4acce3
Okay, that's not it
Sep 26, 2017
33b4ab0
A few more edits and link fix
Sep 26, 2017
c72f42c
Few more minor edits
Sep 26, 2017
b74d419
Bit of an edit
Sep 26, 2017
1856d87
Breaking the compiler guide to pages
Sep 26, 2017
ea84e78
Verbs for headers
Sep 26, 2017
2353271
Is the bad indent the problem?
Sep 26, 2017
70d3453
Fixing links
Sep 26, 2017
8af6909
Small edit
Sep 26, 2017
088e9ad
Linking to new doxy
Sep 26, 2017
680a256
I didn't like "such as" when there's only one option
Sep 26, 2017
de15835
Tiny change
Sep 26, 2017
36c7c0e
I don't like "undergoes" when it's referring to an example
Sep 26, 2017
418bb8c
Making header levels internally consistent
Sep 26, 2017
b47bb8b
The cost of copy/pasting
Sep 26, 2017
eb2a5d5
That seems wrong - the intro was after a page
Sep 26, 2017
bf2d04c
Spans - although maybe the idea was to display them side by side?
Sep 26, 2017
237e192
Consistent spelling (possibly the wrong one) + links
Sep 26, 2017
a5cde3c
Spans and consistent header levels
Sep 26, 2017
b6b97d6
Links
Sep 26, 2017
500fb80
Mustn't be relative
Sep 26, 2017
dd90d20
Transclusion can't have relative links
Sep 26, 2017
2c5e23f
Removing missing header - replacing with GitHub link
Sep 26, 2017
d11925b
Removing dead example
Sep 26, 2017
d742618
Removing uVisor because it breaks the engine
Sep 26, 2017
9cb9fac
Must point to cpp, not root folder
Sep 26, 2017
48339e4
Must link to cpp, not the repo itself
Sep 26, 2017
4e62bb6
Transclusion to new doxy site
Sep 26, 2017
2c695f9
Replacing a few more links
Sep 26, 2017
727c47c
And a few more
Sep 26, 2017
54dcdfe
We don't have that in the doxy
Sep 26, 2017
ed58687
Open tag
Sep 26, 2017
61d746b
That was a bit silly
Sep 26, 2017
01b71e0
v5.4 - > v5.6
Sep 26, 2017
ade11e1
Update tools_intro.md
sg- Sep 26, 2017
51047e8
Merge pull request #271 from ARMmbed/sg--patch-1-1
Sep 26, 2017
3abfa8e
Update docs.json
Sep 26, 2017
a2de2e9
Move porting information
Sep 26, 2017
44ca1c8
Update docs.json
Sep 26, 2017
cc7deb8
Update readme.md
Sep 26, 2017
7e96646
Delete link in MeshInterface.md
Sep 26, 2017
b598d5c
Update Error.md
Sep 26, 2017
507d3d0
Update docs.json
Sep 26, 2017
4e35d45
docs.mbed.com to os.mbed.com/docs
Sep 26, 2017
3466d31
Delete line
Sep 26, 2017
c1a8f11
Fix image in serial_communication.md
Sep 26, 2017
867f63d
Fix link in thread_safety.md
Sep 26, 2017
873242b
Fix link in TLS.md
Sep 26, 2017
f5499f5
Update MeshInterface.md
Sep 26, 2017
0a73f57
Update link in flash.md
Sep 26, 2017
49fff1a
Fix link in bluetooth.md
Sep 26, 2017
08c3730
Link fix and picking one style for all page and button names
Sep 27, 2017
dab1254
Formatting
Sep 27, 2017
2c3b422
Formatting and a couple of typos
Sep 27, 2017
3f426a3
Formatting
Sep 27, 2017
4943b16
Some links and formatting
Sep 27, 2017
ae25408
Link should be relative and include .html
Sep 27, 2017
c8c4e41
What even happened there?
Sep 27, 2017
90e52d9
Removing link to unpublished page
Sep 27, 2017
6af6d7e
Fixing links but we don't have HDK
Sep 27, 2017
8c5eb29
Fix HDK link
Sep 27, 2017
2a34101
Minor formatting tweak
Sep 27, 2017
2e8c48c
My bad
Sep 27, 2017
9446941
Update docs.json
Sep 27, 2017
e5959a3
Fix link in bluetooth.md
Sep 27, 2017
77c860a
Fix chapter title
Sep 27, 2017
1614520
Update cli.md
Sep 27, 2017
1990000
Update docs.json
Sep 27, 2017
df433be
Retitle debug_builds_cli.md
Sep 27, 2017
b2cd33a
Retitle build_profiles.md
Sep 27, 2017
d31c3b0
Update docs.json
Sep 27, 2017
ee6b364
Update online_comp.md
Sep 27, 2017
94eb059
Update docs.json
Sep 27, 2017
a224ffe
Retitle onine_comp.md
Sep 27, 2017
57c60cc
Shorten title
Sep 27, 2017
136e587
Fix heading level
Sep 27, 2017
206ced2
Capitalize title words
Sep 27, 2017
b0b08b0
Update docs.json
Sep 27, 2017
97f8c5d
Lower case title
Sep 27, 2017
045853f
Standardize capitalization in api.md
Sep 27, 2017
78bd396
Standardize capitalization
Sep 27, 2017
9aee319
Standardize capitalization
Sep 27, 2017
78d98cd
Standardize phrasing
Sep 27, 2017
668b07f
Standardize phrasing
Sep 27, 2017
ad6995b
Standardize capitalization in DigitalIn.md
Sep 27, 2017
f536858
Update DigitalInOut.md
Sep 27, 2017
3334104
Update DigitalOut.md
Sep 27, 2017
88a6187
Update I2C.md
Sep 27, 2017
88cc443
Update InterruptIn.md
Sep 27, 2017
2d1603c
Update PortIn.md
Sep 27, 2017
c3aeb60
Update PortInOut.md
Sep 27, 2017
7939503
Update PortOut.md
Sep 27, 2017
863a88e
Update PwmOut.md
Sep 27, 2017
df1487b
Update SPI.md
Sep 27, 2017
ed5e6eb
Update Serial.md
Sep 27, 2017
3d47a90
Update Ticker.md
Sep 27, 2017
4b4f270
Update TimeOut.md
Sep 27, 2017
145feae
Update Timer.md
Sep 27, 2017
49b5422
Update rtos.md
Sep 27, 2017
d61f8ea
Fix formatting in Event.md
Sep 27, 2017
f1fdead
Update networksocket.md
Sep 27, 2017
af49fe6
Update WifiInterface.md
Sep 27, 2017
709dc69
Update CellularInterface.md
Sep 27, 2017
b82a428
Update BLE.md
Sep 27, 2017
1b30d64
Fix headings in BlockDevice.md
Sep 27, 2017
0b28071
Fix headings
Sep 27, 2017
226b579
Update storage.md
Sep 27, 2017
09e8112
Update tools_intro.md
Sep 28, 2017
d2de01d
Update cli.md
Sep 28, 2017
e056443
Update cli-setup.md
Sep 28, 2017
e2523e8
Update cli-test-debug.md
Sep 28, 2017
86672ee
Update cli-test-debug.md
Sep 28, 2017
d27d7de
Update build_profiles.md
Sep 28, 2017
b362ce8
Update testing.md
Sep 28, 2017
fa338d1
Update tutorials_intro.md
Sep 28, 2017
0b22bdd
Update first_program.md
Sep 28, 2017
235729b
Update serial_communication.md
Sep 28, 2017
dd221a1
Update bootloader.md
Sep 28, 2017
e4bd163
Update memap.md
Sep 28, 2017
33c73f0
OS_IDLE_THREAD_STACK_SIZE was increased to 512bytes for tickless RTX
Sep 28, 2017
d6d60e6
Cortex specific RTX was moved to TARGET_CORTEX in PR #5003
Sep 28, 2017
5a0395d
IAR context switch file was added for cortex-M23 in PR #4875
Sep 28, 2017
c00f8b2
IAR context switch file was added for cortex-M33 in PR #5105
Sep 28, 2017
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
386 changes: 386 additions & 0 deletions docs.json

Large diffs are not rendered by default.

Binary file added docs/images/6lh.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/images/6lowpan_network_architecture.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/images/6lowpan_stack_architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/images/6lowpan_stack_osi_model.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/images/6lr.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/images/Cell_AT.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/images/Cell_PPP.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/images/DeviceOnMac.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/images/DeviceOnWindows.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/images/Mutex.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/images/NUCLEOF401RE.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/images/NanostackRfPhy.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/images/Semaphore.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/images/accept_pull_request.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/images/add_board.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/images/all_programs.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/images/basic_collab.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/images/br.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/images/browser-panel.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/images/bw.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/images/cellular_block_dia.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/images/changes_to_merge.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/images/commit_merge.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/images/compare_repo.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/images/compare_revisions.png
Binary file added docs/images/comparing_repos.png
Binary file added docs/images/compile-output.png
Binary file added docs/images/compile.png
Binary file added docs/images/compileandinstall.png
Binary file added docs/images/compiling.png
Binary file added docs/images/conflict_files.png
Binary file added docs/images/conflict_review.png
Binary file added docs/images/create-program.png
Binary file added docs/images/create_pull_request.png
Binary file added docs/images/device_on_mac.png
Binary file added docs/images/docs_example.png
Binary file added docs/images/docs_in_library_1.png
Binary file added docs/images/docs_in_library_2.png
Binary file added docs/images/docs_preview1.png
Binary file added docs/images/docs_preview2.png
Binary file added docs/images/docs_update.png
Binary file added docs/images/eclipse1.png
Binary file added docs/images/eclipse2.png
Binary file added docs/images/eclipse3.png
Binary file added docs/images/eclipse4.png
Binary file added docs/images/eclipse5.png
Binary file added docs/images/eclipse6.png
Binary file added docs/images/eclipse7.png
Binary file added docs/images/eclipse8.png
Binary file added docs/images/eclipse9.png
Binary file added docs/images/ed_scan_process.png
Binary file added docs/images/editor-overview.png
Binary file added docs/images/eventflags_usage.png
Binary file added docs/images/examples.png
Binary file added docs/images/export_menu.png
Binary file added docs/images/fork.png
Binary file added docs/images/fork_indication.png
Binary file added docs/images/fpu_iar.png
Binary file added docs/images/green_revisions.png
Binary file added docs/images/import-mbed-os.png
Binary file added docs/images/import_button_comp.png
Binary file added docs/images/import_button_site.png
Binary file added docs/images/import_dialog.png
Binary file added docs/images/import_mbed.png
Binary file added docs/images/import_popup.png
Binary file added docs/images/import_pull_request.png
Binary file added docs/images/incoming_revisions.png
Binary file added docs/images/inherit_from_generic_modem.png
Binary file added docs/images/join_process_star_6lowpan_router.png
Binary file added docs/images/lights1.gif
Binary file added docs/images/lights1.png
Binary file added docs/images/lights2.gif
Binary file added docs/images/lights2.png
Binary file added docs/images/lights3.gif
Binary file added docs/images/lights3.png
Binary file added docs/images/mail_queue.png
Binary file added docs/images/main-toolbar.png
Binary file added docs/images/main_cpp.png
Binary file added docs/images/maincpp.png
1 change: 1 addition & 0 deletions docs/images/mbed OS 5 protection.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<mxfile userAgent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4" version="6.8.9" editor="www.draw.io" type="device"><diagram id="d7a15faf-bf4b-0056-54cb-1d26b8fdf24f" name="Page-1">zZZbc6IwFIB/De+QIOCjS2m7D1VH2NnnCAfINBAnxqL76zdAVGjoXqY81AcnfCeXk+9kAhYOq/OTIIfyhWfALGRnZws/WAj5vqv+W3DpwQJrUAia9ci5g5j+Ag1tTU80g+Ooo+ScSXoYw5TXNaRyxIgQvBl3yzkbr3ogBRggTgkz6U+aybKnAfLv/BloUV5XdrxlH9mT9LUQ/FTr9SyE8+7XhytynUtv9FiSjDcDhCMLh4Jz2beqcwisVXvV1o97/CB6y1tALf9lwKIf8EbYCa4Zd3nJy9VFtxto+9sW/taUVEJ8IGkbbVTxFStlxdSTo5rm+jqlNxASzgOk83kCXoEUF9VFR5dajT46KNDPzb0QrqdZOSgC8jUkuvjFbeq7ANXQDqZ9YMNH8ryLVqphx6vHyJCjRqszCX8X0+6fqgO2YrSoFZO87ZBTxkLOuOhmw9kCgsxV/CgFf4VBJEB77HnzCHacsWHsuqZhNGHYCWYw7BqGv6+TaLf7sU1ml1zRLGsnMTwTCPJ0yrOXBrDP5/GMFu88B0vDM8ITnpczaPYNzetNK3i72yRRmEQPhmW1KznWObZT8/q9So2I1p0qVyD+VIep+s1g2nXcsWnbvDMc25s40TOYDgzT4eZlu1lH6yT+MpJzXstYpzHxkvj0HXI768M7ZOqS/n/h6vH+Puxig28OHP0G</diagram></mxfile>
Binary file added docs/images/mbed-OS-5-protection.png
Binary file added docs/images/mbedOS_sockets.png
Binary file added docs/images/mbed_internal.png
Binary file added docs/images/mbed_internals.PNG
Binary file added docs/images/mbed_internals.jpg
Binary file added docs/images/mesh.png
Binary file added docs/images/mult_authors.png
Binary file added docs/images/multi_revision_history.png
Binary file added docs/images/nanostack_in_mbed_OS.png
Binary file added docs/images/network_bootstrap_high_level_view.png
Binary file added docs/images/new.png
Binary file added docs/images/new_file.png
Binary file added docs/images/new_library.png
Binary file added docs/images/new_program.png
Binary file added docs/images/node_to_server.png
Binary file added docs/images/open_pull_requests.png
Binary file added docs/images/other_ides1.png
Binary file added docs/images/pin_out.png
Empty file added docs/images/placeholder.md.txt
Empty file.
Binary file added docs/images/printf1.png
Binary file added docs/images/printf2.png
Binary file added docs/images/printf3.png
Binary file added docs/images/printf4.png
Binary file added docs/images/printf5.png
Binary file added docs/images/privacy_settings.png
Binary file added docs/images/publish.png
Binary file added docs/images/publish_deatils.png
Binary file added docs/images/publish_prompt.png
Binary file added docs/images/published_repo.png
Binary file added docs/images/pull_request_accepted.png
Binary file added docs/images/pull_request_closed.png
Binary file added docs/images/pull_request_created.png
Binary file added docs/images/queue.png
Binary file added docs/images/reject_pull_request.png
Binary file added docs/images/repo_details.png
Binary file added docs/images/repo_url.png
Binary file added docs/images/repo_url_compare.png
Binary file added docs/images/review_pull_request.png
Binary file added docs/images/revision_history_overview.png
Binary file added docs/images/revision_history_pull_request.png
Binary file added docs/images/rpl_layer_reg_multiple_hops.png
Binary file added docs/images/rpl_layer_reg_single_hop.png
Binary file added docs/images/rpl_mesh_high_level_view.png
Binary file added docs/images/rtos_timer.png
Binary file added docs/images/select_board.png
Binary file added docs/images/select_target.png
Binary file added docs/images/select_toolchain.png
Binary file added docs/images/show_board.png
Binary file added docs/images/single_channel.png
Binary file added docs/images/star_topology.png
Binary file added docs/images/state_machine_6lowpan.png
Binary file added docs/images/thread_arch.png
Binary file added docs/images/thread_priority.png
Binary file added docs/images/thread_status.png
Binary file added docs/images/two_channels.png
Binary file added docs/images/tx_process.png
Binary file added docs/images/uVision.png
Binary file added docs/images/update_from.png
Binary file added docs/images/updates.png
Binary file added docs/images/uvision1.png
Binary file added docs/images/uvision2.png
Binary file added docs/images/uvision3.png
Binary file added docs/images/vscode1.png
Binary file added docs/images/vscode2.png
Binary file added docs/images/vscode3.png
Binary file added docs/images/vscode4.png
Binary file added docs/images/vscode5.png
Binary file added docs/images/with_mbed.png
107 changes: 107 additions & 0 deletions docs/introduction/examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
## Examples and Videos

### Blinky

- [Blinky](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-blinky/): our basic application, showing how to use the APIs to control the LED on the board.

### End to end projects

- [LoRa on Arm Mbed](https://docs.mbed.com/docs/lora-with-mbed/en/latest/)
- [Internet connected lighting system](https://docs.mbed.com/docs/building-an-internet-connected-lighting-system/en/latest/)

### Our YouTube channel

[https://www.youtube.com/armmbed/](https://www.youtube.com/armmbed/)

### BBC micro:bit

A few micro:bit How To videos:

- [Hello world](https://www.youtube.com/watch?v=Jctpi6aqrHQ)
- [Accelerometer](https://www.youtube.com/watch?v=_WGKBxSW_AE)
- [Proximity heart](https://www.youtube.com/watch?v=xKWQSjg6rX4)

### JavaScript on Arm Mbed OS 5

- [Building IoT devices with JavaScript](https://os.mbed.com/javascript-on-mbed/)
- [Blinky in JavaScript](https://github.com/ARMmbed/mbed-js-example)
- [Bluetooth Low Energy in JavaScript](https://github.com/ARMmbed/mbed-js-ble-example)
- [JavaScript REPL](https://github.com/janjongboom/mbed-js-repl-example)

### Component examples

#### Security

##### Arm Mbed TLS

- [Cryptographic benchmark](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-tls-benchmark/): benchmarks the various cryptographic primitives offered by Arm Mbed TLS.
- [Authenticated encryption and decryption](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-tls-authcrypt/): performs authenticated encryption and authenticated decryption of a buffer. It serves as a tutorial for the basic authenticated encryption functions of Mbed TLS.
- [Hashing](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-tls-hashing/): performs hashing of a buffer with SHA-256 using various APIs. It serves as a tutorial for the basic hashing APIs of Mbed TLS.
- [TLS client](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-tls-tls-client/): downloads a file from an HTTPS server (os.mbed.com) and looks for a specific string in that file.

##### Arm Mbed uVisor

- [Threaded Blinky with uVisor](https://github.com/ARMmbed/mbed-os-example-uvisor-thread): an example threaded application with uVisor security.
- [IRQ Blinky uVisor](https://github.com/ARMmbed/mbed-os-example-uvisor): an example threaded application with uVisor security and IRQ support.
- [Threaded REPC with uVisor](https://github.com/ARMmbed/mbed-os-example-uvisor-number-store): using uVisor APIs to build a box that stores a number.

These examples work on the K64F and the GNU Arm Embedded toolchain only.

#### Core features

##### File system

[Get the FAT file system working on an Mbed OS platform](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-fat-filesystem/).

##### Bootloader

- [Create a bootloader](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-bootloader/).
- [Use a blinky application with a prebuilt bootloader](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-bootloader-blinky/).

#### mbed Client

[Getting started](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-client/): a basic example of mbed Client for Mbed OS. It demonstrates how to register a device with Mbed Device Connector, how to read and write values and how to deregister.

### Connectivity

- [HTTP](http://github.com/armmbed/mbed-os-example-http) and [HTTPS](https://github.com/ARMmbed/mbed-os-example-tls/blob/master/tls-client/main.cpp).
- [MQTT](https://os.mbed.com/teams/mqtt/code/HelloMQTT/).
- [CoAP](https://github.com/armmbed/mbed-os-example-coap).

#### mesh

[Join a device to an insecure 6LoWPAN-ND or Thread network](https://os.mbed.com/teams/mbed-os-examples/code/nanostack-border-router). This is the simplest use of the mesh networking stack.

#### Nanostack border router

[Use the generic Mbed border router and create a 6LoWPAN-ND or Thread network](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-mesh-minimal/). Your 6LoWPAN or Thread devices can access to internet using this gateway.

#### Sockets

[Perform a transaction over TCP using the network-socket API](https://github.com/ARMmbed/mbed-os-example-sockets).

#### Wi-Fi

[Perform simple HTTP operations using the Wi-Fi interface](https://github.com/ARMmbed/mbed-os-example-wifi).

#### Bluetooth Low Energy (BLE)

- [Battery level](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-ble-BatteryLevel/): use the Battery Level service to transmit a device's battery level.

- [BLE button](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-ble-Button/): BLE service template for a read-only characteristic.

- [GAP button](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-ble-GAPButton/): use GAP to transmit a value to a peer that's listening for advertisements.

- [Heart rate](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-ble-HeartRate/): transmit a heart rate value using the SIG Heart Rate profile.

- [Thermometer](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-ble-Thermometer/): send thermometer information using the Health Thermometer Profile.

- [Simple LED control](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-ble-LED/): a client using a read/write characteristic to control an LED. This example goes with the [LED blinker](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-ble-LEDBlinker/), a server that uses the GATT client API to control the BLE client device.

- Beacons send a small amount of information to a nearby device. Try:
- [BLE beacon](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-ble-Beacon/).
- [Eddystone beacon](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-ble-EddystoneService/). Try it with the [Eddystone observer](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-ble-EddystoneObserver/), which scans for beacons.

#### Peripherals

[On os.mbed.com](https://os.mbed.com/teams/mbed_example/)
86 changes: 86 additions & 0 deletions docs/introduction/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
## Mbed OS 5

Arm Mbed OS lets you write applications that run on embedded devices, by providing the layer that interprets your application's code in a way the hardware can understand.

Your application code is written in C and C++. It uses the *application programming interfaces* (APIs) that Mbed OS provides. These APIs allow your code to work on different microcontrollers in a uniform way. This reduces the challenges of getting started with Arm-based microcontrollers and integrating large software projects.

#### Where to start

<span class="tips">If you're working on Windows, you might need to [install a serial driver](/docs/v5.6/tutorials/windows-serial-driver.html).</span>

The easiest way to work with Mbed OS is using one of our development tools. We've set up an example, [Blinky](/docs/v5.6/tutorials/your-first-arm-mbed-application.html), that you can try on each of the tools. Blinky teaches you to build and run an application on your board.

Once you know how to build an existing application, it's time to learn [how to write your own applications](/docs/v5.6/reference/index.html).

##### Development tools

- Our offline development tool is [Arm Mbed CLI](/docs/v5.6/tools/mbed-cli.html), a command-line tool. This requires having a toolchain installed on your computer.
- The [Arm Mbed Online Compiler](/docs/v5.6/tools/arm-mbed-online-compiler.html) lets you write and build applications using a web browser.
- If you're working with third party tools, look at [exporting instructions for the most popular ones](/docs/v5.6/tools/exporting.html).

##### Communicating with and monitoring your board

You can [monitor and control an Mbed board](/docs/v5.6/tutorials/serial-communication-overview.html) to help you debug and test your applications.

<span class="tips">**Tip:** You can learn more about debugging [here](/docs/v5.6/tutorials/debugging-applications.html).</span>

#### How to continue

When you've started writing applications using your selected development tool:

- Learn about [collaborative work and version control](/docs/v5.6/tools/collab-online-comp.html).
- Try one of the [tutorials](/docs/v5.6/tutorials/index.html), which cover concepts such as debugging and memory tracing.
- Ask questions and give advice on the [forum](https://forums.mbed.com/).

#### Contributing to Mbed OS

If you want to contribute to the `mbed-os` codebase, please see [the contribution section](/docs/v5.6/reference/contributing-overview.html).

You can find past releases and the current release on [GitHub](https://github.com/ARMmbed/mbed-os/releases/).

#### Porting to Mbed OS

Our full contributing guide is still being written. For now, we have:

- A guide to [contributing targets](/docs/v5.6/reference/contributing-target.html).
- Information about the [tools you need to contribute targets](/docs/v5.6/reference/contributing-tools.html).
- APIs about [storage](/docs/v5.6/reference/contributing-storage.html) and [connectivity](/docs/v5.6/reference/contributing-connectivity.html) in relation to porting.

## How Mbed works

The Arm Mbed hardware architecture is designed to make sure you have all the tools and utilities to be productive. Most boards have an integrated debug circuit that assists development by programming the device, logging program execution and giving access to the debug access port. Here is how it works.

#### Architecture diagram

This is the basic architecture of an [Mbed board](/docs/v5.6/introduction/how-mbed-works.html):

<span class="images">![](https://s3-us-west-2.amazonaws.com/mbed-os-docs-images/mbed_internal.png)<span>A sketch of a typical Mbed board's hardware architecture</span></span>

#### How programming works

There are two options:

1. When you plug an Mbed Enabled board to your PC using USB, it appears as a USB flash disk. The Mbed interface presents this small disk. It allows you to save Arm microcontroller binaries you want to run directly on to the board, without drivers.
2. The same USB connection exposes a debug protocol such as CMSIS-DAP. This enables lots of IDEs to program and debug the device.

##### How USB serial works

The Arm Mbed interface also presents a USB serial/com interface. This is basically a UART-USB bridge, and it connects to the interface's UART. So if you send characters out of the target board's UART, the Arm Mbed interface will read them and transfer them over the USB link. When you `printf()`, it is just sending characters to UART. This means that if you make your own PCB, these characters will still appear on UART.

##### Notes

The `.bin` files the Mbed microcontroller accepts are standard raw binaries. Use any compiler you like to generate them. As the separate interface manages programming over JTAG or SWD, you have unlimited control of the target microcontroller. You really are just loading on a raw binary; this means you can build your own PCB using the same target microcontroller, and the same program binary will run on that.

#### The Arm Mbed interface

You can find more information about the Mbed interface and the circuits on which it runs in the [HDK reference manual](/docs/v5.6/reference/contributing-tools.html#arm-mbed-hdk) or on the [DAPLink GitHub page](https://github.com/ARMmbed/DAPLink/blob/master/README.md). The HDK includes reference circuits you can use to create your own boards, and DAPLink is the firmware that runs on these circuits.

#### Connectivity

The best representation of the connectivity of the Mbed interface is the same diagram we showed above.

The Mbed interface:

- Provides a USB connection to the host computer, which exposes a Mass Storage (flash disk) and a USB serial port.
- Has an SWD or JTAG connection to the target, so it can program the target flash. You can also use this for debugging.
- A physical UART connection exists between the target and the interface, which is relayed over the interface's USB serial port.
149 changes: 149 additions & 0 deletions docs/introduction/terms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
## Glossary

### A

**API** - [Application programming interface](/docs/v5.6/reference/api.html).

**Application** - An executable module built out of libraries that acts as a final product.

**Arm Mbed CLI** - The name of the Arm Mbed [command-line tool](/docs/v5.6/tools/mbed-cli.html), packaged as `mbed-cli`.

**Arm Mbed interface** - The extra chip that sits on all [Mbed Enabled development boards](/docs/v5.6/introduction/how-mbed-works.html#architecture-diagram). It's what makes the target chip (for example, K64F) look like a USB drive. It usually runs a separate piece of software that generally doesn't change. That software is usually `DAPLink`, `CMSIS-DAP` or `STLink`.

**Arm Mbed Online Compiler** - [Arm’s online tool](/docs/v5.6/tools/online.html), which you can use to create and compile your code.

**Arm Mbed OS** - Arm's [platform operating system](https://os.mbed.com/docs) for the Internet of Things.

**Arm Mbed TLS** - A [comprehensive SSL/TLS solution](/docs/v5.6/reference/tls.html) that makes it easy for developers to include cryptographic and SSL/TLS capabilities in their software and embedded products. As an SSL library, it provides an intuitive API, readable source code and a minimal and highly configurable code footprint.

**Arm Mbed uVisor** - A self-contained [software hypervisor](/docs/v5.6/reference/tls.html#uVisor) that creates independent secure domains on ARM Cortex-M3 and M4 micro-controllers.

### B

**Bit** - A basic unit of digital information that can be one of two values: `0` (`false`) or `1` (`true`).

**BLE** - [Bluetooth Low Energy](/docs/v5.6/reference/ble.html).

**Blinky** - An [example application](/docs/v5.6/tutorials/your-first-arm-mbed-application.html) that you can use to get to know Arm Mbed OS and the development tools. It’s one of the simplest examples of Mbed OS.

**Block Device** - A [file](/docs/v5.6/reference/contributing-storage.html#block-devices) that represents a device, with data that can be read or written to it in blocks.

**Board** - An Mbed Enabled development board. You can see a complete list of these [here](https://os.mbed.com/platforms/).

**Boolean** - A binary variable, having two possible values called `true` and `false`.

**Bootloader** - [The program](/docs/v5.6/tutorials/creating-and-using-a-bootloader.html) that loads Mbed OS when a board is turned on.

**Build Profile** - Mbed OS 5 supports three primary [build profiles](/docs/v5.6/tools/mbed-cli.html#build-profiles): develop, debug and release.

**Build Script** - A build automation and generation utility.

**Byte** - A unit of digital information that consists of 8 bits (see `Bit`).

### C

**Callback** - Any [executable code](/docs/v5.6/reference/api-references.html#callback) that is passed as an argument to other code, which is expected to call back (execute) the argument at a given time.

**CAN** - [Controller-area network](/docs/v5.6/reference/api-references.html#can).

**Class** - An extensible program-code-template for creating objects, providing initial values for state and implementations of behavior.

**CI** - Continuous integration.

**CLI** - Command-line interface.

**CMSIS-DAP** - The precursor to DAPLink, this [project](https://github.com/mbedmicro/cmsis-dap) is deprecated due to known bugs. You should not use it in any new designs.

### D

**DAPLink** - An Arm maintained [project](https://github.com/mbedmicro/DAPLink) that is under active development.

**Debugging** - The [process](/docs/v5.6/tools/debugging.html) of finding and solving problems in code.

**Deprecation** - Marking a piece of code as out of date. You should not write new code that depends on deprecated APIs. We will remove deprecated APIs when our code no longer depends on them.

### E

**Exporter** - Use the Arm Mbed [exporters](/docs/v5.6/tools/exporting.html#about-the-exporters) to export your code to various third party tools and IDEs.

### G

**GitHub** - A web-based [Git development platform](https://github.com/armmbed/mbed-os) for version-controlled repositories.

**GPIO** - General-purpose input/output, a generic pin that is controllable by the user at run-time.

**Greentea** - **G**eneric **re**gression **en**vironment for **te**st **a**utomation. [Greentea](/docs/v5.6/tools/tools-testing.html#greentea) is the automated testing tool for Arm Mbed OS development.

### H

**htrun** - An Mbed OS command used to drive test binary flashing, device reset and test execution.

### I

**I2C** - [Interintegrated Circuit](/docs/v5.6/reference/api-references.html#i2c) (short-distance, intraboard communication).

**IDE** - Integrated Development Environment.

**int** - Short for "integer", it is a variable type that can be used to define numeric variables holding whole numbers.

### L

**Library** - A module that you can use to build applications.

**LoRA** - Long range (low power wireless platform).

### M

**Makefile** - A file containing a set of directives used with the make build automation tool.

**Mesh** - A network topology in which each node relays data for the network.

**Module** - A self-contained unit of code containing classes and functions.

### N

**Nibble** - A unit of digital information that consists of 4 bits (see `Bit`).

### P

**Platform** - See `board`.

**Porting** - A process to add target support to Mbed OS.

**Program** - See `application`.

**Pull Request** - Used by version-controlled repositories to propose and collaborate on changes.

### R

**REST** - Representational State Transfer (API).

**RTOS** - [Real-Time Operating System](/docs/v5.6/reference/rtos-api.html).

### S

**Serial** - A [protocol](/docs/v5.6/reference/api-references.html#serial) used in data transmission for the transfer of individual bits of information.

**SPI** - [Serial Peripheral Interface](/docs/v5.6/reference/api-references.html#spi).

**Static Memory** - The allocation of memory at compile time, before the program is executed.

**SSL** - Secure sockets layer.

**STLink** - STMicro's [firmware](http://www.st.com/content/st_com/en/products/embedded-software/development-tool-software/stsw-link007.html) that performs the same tasks as DAPLink but uses a different [driver](http://www.st.com/content/st_com/en/products/embedded-software/development-tool-software/stsw-link009.html).

### T

**Target** - See [`board`](/docs/v5.6/introduction/glossary.html#board).

**Terminal Application** - [Applications](/docs/v5.6/tutorials/serial-communication.html#terminal-applications) that run on your host PC that provide a window where your Mbed board can print and where you can type characters back to your board.

**TLS** - Transport Layer Security.

**Toolchain** - A [group of programming tools](/docs/v5.6/tools/exporting.html#setting-up-a-local-debug-toolchain).

**Travis CI** - a continuous integration service used to build and test software projects hosted at GitHub (see `GitHub`).

### U

**utest** - A [test harness](/docs/v5.6/tools/tools-testing.html#utest-asynchronous-c-test-harness) you can use to execute a specified series of (asynchronous) C++ test cases.
Loading