Migrate docs from the other repo

This commit is contained in:
Michal Moskal
2016-03-25 16:47:20 -07:00
parent 38d2cf06d2
commit a08eb53f92
895 changed files with 36888 additions and 0 deletions

View File

@ -0,0 +1,35 @@
# On Data Received
Registers code to run when a packet is received over ``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.onDataReceived(() => {})
```
### Parameters
* body - is an action
### Example
```blocks
basic.forever(() => {
radio.sendNumber(input.acceleration(Dimension.X));
})
radio.onDataReceived(() => {
led.plotBarGraph(radio.receiveNumber(), 1023);
})
```
### See also
[receive number](/microbit/radio/receive-number), [send number](/microbit/radio/send-number), [set group](/microbit/reference/radio/set-group)

View File

@ -0,0 +1,34 @@
# Receive Number
Reads the next radio packet if any and returns the first number.
## 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.receiveNumber()
```
### Return value
* the first number [number](/microbit/reference/types/number) of the packet if any. `0` otherwise.
### Examples
Read the number broadcasted by other micro:bits.
```blocks
radio.onDataReceived(() => {
led.plotBarGraph(radio.receiveNumber(), 1023);
})
```
### See also
[receive number](/microbit/input/receive-number), [on data received](/microbit/reference/radio/on-data-received)

View File

@ -0,0 +1,34 @@
# Send Number
Broadcasts a number 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.sendNumber(0)
```
### Parameters
* packet - a number to be transmitted.
### Examples
Broadcasts the value of ``acceleration`` x to other micro:bits.
```blocks
input.onButtonPressed(Button.A, () => {
radio.sendNumber(input.acceleration(Dimension.X))
})
```
### See also
[receive number](/microbit/input/receive-number), [on data received](/microbit/reference/radio/on-data-received)

View File

@ -0,0 +1,34 @@
# Set Group
Sets the group id for ``radio`` communications. A micro:bit can only listen to one group ID at any time.
Unless specified, the group id is automatically inferred from the script source. Every script with the same exact source code with start with the same group id.
## 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.setGroup(1)
```
### Parameters
* ``id`` -- a [number](/microbit/number) between ``0`` and ``255``.
### Example
Sets the group to 128.
```blocks
radio.setGroup(128)
```
### See also
[receive number](/microbit/radio/receive-number), [send number](/microbit/radio/send-number), [on data received](/microbit/radio/on-data-received)