From 318ffde27ff3f5c2d334a8be9ccf46c8d6d429a3 Mon Sep 17 00:00:00 2001 From: gbaman Date: Wed, 25 May 2016 01:53:13 +0100 Subject: [PATCH] Add send-string documentation page --- docs/reference/radio/send-string.md | 33 +++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 docs/reference/radio/send-string.md diff --git a/docs/reference/radio/send-string.md b/docs/reference/radio/send-string.md new file mode 100644 index 00000000..872c1d04 --- /dev/null +++ b/docs/reference/radio/send-string.md @@ -0,0 +1,33 @@ +# Send String + +Broadcasts a string data packet to other micro:bits connected via ``radio``. + +## Important Security Consideration + +The functions in the ``radio`` namespace allow the BBC micro:bit to communicate with other micro:bits. + +This API does not contain any form of encryption, authentication or authorization. It's purpose is solely for use as a teaching aid to demonstrate how simple communications operates, and to provide a sandpit through which learning can take place. + +For serious applications, BLE should be considered a substantially more secure alternative. + +```sig +radio.sendString("Hello world!") +``` + +### Parameters + +* msg - a string to be transmitted. + +### Examples + +Broadcasts the provided string to other micro:bits. + +```blocks +input.onButtonPressed(Button.A, () => { + radio.sendString("Mr. Watson, come here, I want to see you.") +}) +``` + +### See also + +[receive string](/reference/radio/receive-string), [on data received](/reference/radio/on-data-received)