Radiodocsupdate (#1430)
* a few updates * more updates * reorder radio blocks * more shuffling of new radio apis * fixing hot or ocold * more doc fixes * more updates * fixing docs issues * more doc fixes * restore docs errors * missing packate * renamed argument of callback * mssing radio * more odcs fixes * lock turtle * ignore docs for now
This commit is contained in:
@ -34,7 +34,7 @@ thing from nearby @boardname@s. It shows these numbers as a
|
||||
basic.forever(() => {
|
||||
radio.sendNumber(input.acceleration(Dimension.X));
|
||||
})
|
||||
radio.onDataPacketReceived(({ receivedNumber }) => {
|
||||
radio.onReceivedNumber(function (receivedNumber) {
|
||||
led.plotBarGraph(receivedNumber, 1023);
|
||||
})
|
||||
```
|
||||
|
@ -1,6 +1,6 @@
|
||||
# On Data Received
|
||||
|
||||
> Note: This API has been deprecated! Use [on data packet received](/reference/radio/on-data-packet-received) instead.
|
||||
> Note: This API has been deprecated! Use [on received number](/reference/radio/on-received-number) instead.
|
||||
|
||||
Run part of a program when the @boardname@ receives a
|
||||
[number](/types/number) or [string](/types/string) over ``radio``.
|
||||
@ -28,7 +28,7 @@ radio.onDataReceived(() => {
|
||||
|
||||
## See also
|
||||
|
||||
[on data packet received](/reference/radio/on-data-packet-received),
|
||||
[on received number](/reference/radio/on-received-number),
|
||||
[send number](/reference/radio/send-number), [set group](/reference/radio/set-group)
|
||||
|
||||
```package
|
||||
|
58
docs/reference/radio/on-received-buffer.md
Normal file
58
docs/reference/radio/on-received-buffer.md
Normal file
@ -0,0 +1,58 @@
|
||||
# on Received Buffer
|
||||
|
||||
Run part of a program when the @boardname@ receives a buffer over ``radio``.
|
||||
|
||||
```sig
|
||||
radio.onReceivedBuffer(function (receivedBuffer) {})
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
* **receivedBuffer**: The buffer that was sent in this packet or the empty string if this packet did not contain a string. See [send buffer](/reference/radio/send-buffer)
|
||||
|
||||
## Example: Remote level
|
||||
|
||||
If you load this program onto two @boardname@s, each board will send the level information to the other board.
|
||||
|
||||
```typescript
|
||||
let ax = 0;
|
||||
let ay = 0;
|
||||
basic.forever(() => {
|
||||
ax = input.acceleration(Dimension.X);
|
||||
ay = input.acceleration(Dimension.Y);
|
||||
|
||||
// encode data in buffer
|
||||
let buf = pins.createBuffer(4)
|
||||
buf.setNumber(NumberFormat.Int16LE, 0, ax)
|
||||
buf.setNumber(NumberFormat.Int16LE, 2, ay)
|
||||
radio.sendBuffer(buf)
|
||||
})
|
||||
|
||||
radio.onReceivedBuffer(function (receivedBuffer) {
|
||||
// decode data from buffer
|
||||
ax = receivedBuffer.getNumber(NumberFormat.Int16LE, 0);
|
||||
ay = receivedBuffer.getNumber(NumberFormat.Int16LE, 2);
|
||||
|
||||
// display
|
||||
basic.clearScreen()
|
||||
led.plot(
|
||||
pins.map(ax, -1023, 1023, 0, 4),
|
||||
pins.map(ay, -1023, 1023, 0, 4)
|
||||
)
|
||||
});
|
||||
```
|
||||
|
||||
|
||||
## ~hint
|
||||
|
||||
A radio that can both transmit and receive is called a _transceiver_.
|
||||
|
||||
## ~
|
||||
|
||||
## See also
|
||||
|
||||
[send buffer](/reference/radio/send-buffer)
|
||||
|
||||
```package
|
||||
radio
|
||||
```
|
@ -40,7 +40,7 @@ basic.forever(() => {
|
||||
})
|
||||
radio.onReceivedNumber(function (receivedNumber) {
|
||||
led.plotBarGraph(
|
||||
Math.abs(radio.getReceivedPacketProperty(radio.PacketProperty.SignalStrength) + 42),
|
||||
Math.abs(radio.receivedPacket(RadioPacketProperty.SignalStrength) + 42),
|
||||
128 - 42
|
||||
)
|
||||
})
|
||||
@ -54,7 +54,7 @@ The radio set group might need to be set, synchronized , before the radio events
|
||||
|
||||
## See also
|
||||
|
||||
[on received strig](/reference/radio/on-received-string),
|
||||
[on received string](/reference/radio/on-received-string),
|
||||
[send number](/reference/radio/send-number),
|
||||
[send string](/reference/radio/send-string),
|
||||
[send value](/reference/radio/send-value),
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Receive Number
|
||||
|
||||
> Note: This API has been deprecated! Use [on data packet received](/reference/radio/on-data-packet-received) instead.
|
||||
> Note: This API has been deprecated! Use [on received number](/reference/radio/on-received-number) instead.
|
||||
|
||||
Receives the next number sent by a @boardname@ in the same ``radio`` group.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Receive String
|
||||
|
||||
> Note: This API has been deprecated! Use [on data packet received](/reference/radio/on-data-packet-received) instead.
|
||||
> Note: This API has been deprecated! Use [on received string](/reference/radio/on-received-string) instead.
|
||||
|
||||
Find the next string sent by `radio` from another @boardname@.
|
||||
|
||||
|
@ -1,9 +1,9 @@
|
||||
# get Received Packet Property
|
||||
# Received Packet Property
|
||||
|
||||
Get one of the properties from the last received radio packet.
|
||||
|
||||
```sig
|
||||
radio.getReceivedPacketProperty(radio.PacketProperty.SignalStrength)
|
||||
radio.receivedPacket(RadioPacketProperty.SignalStrength)
|
||||
```
|
||||
|
||||
## Parameters
|
||||
@ -28,7 +28,7 @@ basic.forever(() => {
|
||||
})
|
||||
radio.onReceivedNumber(function (receivedNumber) {
|
||||
led.plotBarGraph(
|
||||
Math.abs(radio.getReceivedPacketProperty(radio.PacketProperty.SignalStrength) + 42),
|
||||
Math.abs(radio.receivedPacket(RadioPacketProperty.SignalStrength) + 42),
|
||||
128 - 42
|
||||
)
|
||||
})
|
||||
@ -37,3 +37,7 @@ radio.onReceivedNumber(function (receivedNumber) {
|
||||
## See also
|
||||
|
||||
[set transmit serial number](/reference/radio/set-transmit-serial-number)
|
||||
|
||||
```package
|
||||
radio
|
||||
```
|
@ -7,7 +7,7 @@ Find how strong the ``radio`` signal is, from `-128` to `-42`.
|
||||
|
||||
The @boardname@ finds the signal strength by checking how strong it was
|
||||
the last time it ran the
|
||||
[on data packet received](/reference/radio/on-data-packet-received) function. That means
|
||||
[on received number](/reference/radio/on-received-number) function. That means
|
||||
it needs to run **receive number** first.
|
||||
|
||||
```sig
|
||||
@ -39,7 +39,7 @@ basic.forever(() => {
|
||||
|
||||
## See also
|
||||
|
||||
[on data packet received](/reference/radio/on-data-packet-received), [send number](/reference/radio/send-number), [on data received](/reference/radio/on-data-received)
|
||||
[on received number](/reference/radio/on-received-number), [send number](/reference/radio/send-number), [on data received](/reference/radio/on-data-received)
|
||||
|
||||
```package
|
||||
radio
|
||||
|
@ -30,7 +30,7 @@ basic.forever(() => {
|
||||
radio.sendBuffer(buf)
|
||||
})
|
||||
|
||||
radio.onDataPacketReceived(({ receivedBuffer }) => {
|
||||
radio.onReceivedBuffer(function (receivedBuffer) {
|
||||
// decode data from buffer
|
||||
ax = receivedBuffer.getNumber(NumberFormat.Int16LE, 0);
|
||||
ay = receivedBuffer.getNumber(NumberFormat.Int16LE, 2);
|
||||
@ -52,7 +52,7 @@ A radio that can both transmit and receive is called a _transceiver_.
|
||||
|
||||
## See also
|
||||
|
||||
[on data packet received](/reference/radio/on-data-packet-received)
|
||||
[on received buffer](/reference/radio/on-received-buffer)
|
||||
|
||||
```package
|
||||
radio
|
||||
|
@ -35,7 +35,7 @@ radio.setTransmitPower(7)
|
||||
|
||||
## See also
|
||||
|
||||
[get received packet property](/reference/radio/get-received-packet-property),
|
||||
[received packet](/reference/radio/received-packet),
|
||||
[send number](/reference/radio/send-number),
|
||||
[send value](/reference/radio/send-value),
|
||||
[send string](/reference/radio/send-string)
|
||||
|
@ -20,7 +20,7 @@ radio.setTransmitSerialNumber(true);
|
||||
|
||||
## See also
|
||||
|
||||
[get received packet property](/reference/radio/get-received-packet-property),
|
||||
[received packet property](/reference/radio/received-packet),
|
||||
[send number](/reference/radio/send-number),
|
||||
[send value](/reference/radio/send-value),
|
||||
[send string](/reference/radio/send-string)
|
||||
|
@ -36,7 +36,7 @@ input.onButtonPressed(Button.A, () => {
|
||||
|
||||
|
||||
});
|
||||
radio.onDataPacketReceived(() => {
|
||||
radio.onReceivedNumber(function (receivedNumber) {
|
||||
radio.writeReceivedPacketToSerial();
|
||||
});
|
||||
```
|
||||
|
Reference in New Issue
Block a user