c_meyer/pxt-calliope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Radio send/receive string. Rewrote text. Updated examples.

Browse Source
This commit is contained in:
Ron Hale-Evans 2016-05-27 12:03:54 -07:00
parent 466bda468f
commit 4fb10faec2
2 changed files with 51 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
docs/reference/radio/receive-string.md
View File

@ -1,14 +1,6 @@
# Receive String # Receive String
Reads the next radio packet if any and returns the first string. Find the next string sent by `radio` from another micro:bit.
## 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 ```sig
radio.receiveString() radio.receiveString()
@ -16,11 +8,11 @@ radio.receiveString()
### Return value ### Return value
* the first [string](/reference/types/string) of the packet if any. ```""``` otherwise. * the first [string](/reference/types/string) that was sent. If no string was sent, then this function returns an empty (blank) string.
### Examples ### Example: Simple receiver
Read the string broadcasted by other micro:bits and display it. Show the string sent by another micro:bit.
```blocks ```blocks
radio.onDataReceived(() => { radio.onDataReceived(() => {
@ -28,7 +20,34 @@ radio.onDataReceived(() => {
}); });
``` ```
A simple program to send whether you are happy, or sad over ```radio```, using the A or B button to select an emotion. ### Example: Two-way radio
If you load this program onto two or more micro:bits, you can send a code word from one of them to the others by pressing button `A`.
The other micro:bits will receive the code word and then show it.
```blocks
input.onButtonPressed(Button.A, () => {
radio.sendString("Codeword: TRIMARAN")
basic.showString("SENT");
})
radio.onDataReceived(() => {
basic.showString(radio.receiveString());
});
```
### ~hint
A radio that can both transmit and receive is called a _transceiver_.
### ~
### Example: Mood radio
This is a simple program to send whether you are happy or sad over ```radio```.
Use the `A` or `B` button to select an emotion.
This program will also receive your friend's mood.
```blocks ```blocks
let data: string = ""; let data: string = "";
@ -64,4 +83,4 @@ radio.onDataReceived(() => {
### See also ### See also
[send string](/reference/input/send-string), [on data received](/reference/radio/on-data-received) [send string](/reference/radio/send-string), [on data received](/reference/radio/on-data-received)

30
docs/reference/radio/send-string.md
View File

@ -1,33 +1,39 @@
# Send String # 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. Sends a string to other micro:bits in the area connected by radio.
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 ```sig
radio.sendString("Hello world!") radio.sendString("Hello!")
``` ```
### Parameters ### Parameters
* msg - a string to be transmitted. * `text` is a [String](/reference/types/string) to send by radio.
### Examples ### Example: Two-way radio
Broadcasts the provided string to other micro:bits. If you load this program onto two or more micro:bits, you can send a code word from one of them to the others by pressing button `A`.
The other micro:bits will receive the code word and then show it.
```blocks ```blocks
input.onButtonPressed(Button.A, () => { input.onButtonPressed(Button.A, () => {
radio.sendString("Mr. Watson, come here, I want to see you.") radio.sendString("Codeword: TRIMARAN")
basic.showString("SENT");
}) })
radio.onDataReceived(() => {
basic.showString(radio.receiveString());
});
``` ```
### ~hint
A radio that can both transmit and receive is called a _transceiver_.
### ~
### See also ### See also
[receive string](/reference/radio/receive-string), [on data received](/reference/radio/on-data-received) [receive string](/reference/radio/receive-string), [on data received](/reference/radio/on-data-received)