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

Control pages now link to Lancaster

Browse Source
This commit is contained in:
Ron Hale-Evans 2016-07-21 13:29:59 -07:00
parent dd94442555
commit c55716e148
8 changed files with 28 additions and 198 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/reference/control/device-name.md
View File

@ -3,30 +3,9 @@
Gets a friendly name for the device derived from the its serial number.
```sig
control.deviceName();
```
### Parameters
* ``a``:
* ``b``:
* ``c``:
### Returns
### Example
The following example / This program does something.
```blocks
```
### See also
[bar bas](/reference/foo/bar-bas),
[bar bas](/reference/foo/bar-bas),
[bar bas](/reference/foo/bar-bas)
**This is an advanced API.** For more information, see the
[micro:bit runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/).

28
docs/reference/control/device-serial-number.md
View File

@ -3,30 +3,8 @@
Derive a unique, consistent serial number of this device from internal data.
```sig
control.deviceSerialNumber();
```
### Parameters
* ``a``:
* ``b``:
* ``c``:
### Returns
### Example
The following example / This program does something.
```blocks
```
### See also
[bar bas](/reference/foo/bar-bas),
[bar bas](/reference/foo/bar-bas),
[bar bas](/reference/foo/bar-bas)
**This is an advanced API.** For more information, see the
[micro:bit runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/).

32
docs/reference/control/event-source-id.md
View File

@ -1,32 +1,10 @@
# Do Something
# Event Source ID
Do something.
Return a code representing the origin of the event on the bus (button, pin, radio, and so on).
```sig
control.eventSourceId(EventBusSource.MICROBIT_ID_BUTTON_A);
```
### Parameters
* ``a``:
* ``b``:
* ``c``:
### Returns
### Example
The following example / This program does something.
```blocks
```
### See also
[bar bas](/reference/foo/bar-bas),
[bar bas](/reference/foo/bar-bas),
[bar bas](/reference/foo/bar-bas)
**This is an advanced API.** For more information, see the
[micro:bit runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/)

28
docs/reference/control/event-timestamp.md
View File

@ -3,30 +3,8 @@
Get the timestamp of the last event executed on the bus
```sig
control.eventTimestamp();
```
### Parameters
* ``a``:
* ``b``:
* ``c``:
### Returns
### Example
The following example / This program does something.
```blocks
```
### See also
[bar bas](/reference/foo/bar-bas),
[bar bas](/reference/foo/bar-bas),
[bar bas](/reference/foo/bar-bas)
**This is an advanced API.** For more information, see the
[micro:bit runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/).

30
docs/reference/control/event-value-id.md
View File

@ -1,32 +1,12 @@
# Do Something
# Event Value ID
Do something.
Return a code representing the type of the event (button click, device gesture, and so on).
```sig
control.eventValueId(EventBusValue.MICROBIT_EVT_ANY);
```
### Parameters
* ``a``:
* ``b``:
* ``c``:
### Returns
### Example
The following example / This program does something.
```blocks
```
### See also
[bar bas](/reference/foo/bar-bas),
[bar bas](/reference/foo/bar-bas),
[bar bas](/reference/foo/bar-bas)
**This is an advanced API.** For more information, see the
[micro:bit runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/).

26
docs/reference/control/event-value.md
View File

@ -3,30 +3,10 @@
Get the value of the last event executed on the bus.
```sig
control.eventValue();
```
### Parameters
* ``a``:
* ``b``:
* ``c``:
### Returns
### Example
The following example / This program does something.
```blocks
```
### See also
[bar bas](/reference/foo/bar-bas),
[bar bas](/reference/foo/bar-bas),
[bar bas](/reference/foo/bar-bas)
**This is an advanced API.** For more information, see the
[micro:bit runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/).

27
docs/reference/control/on-event.md
View File

@ -3,30 +3,9 @@
Raise an event in the event bus.
```sig
control.onEvent(control.eventSourceId(EventBusSource.MICROBIT_ID_BUTTON_A), control.eventValueId(EventBusValue.MICROBIT_EVT_ANY), () => { });
```
### Parameters
* ``a``:
* ``b``:
* ``c``:
### Returns
### Example
The following example / This program does something.
```blocks
```
### See also
[bar bas](/reference/foo/bar-bas),
[bar bas](/reference/foo/bar-bas),
[bar bas](/reference/foo/bar-bas)
**This is an advanced API.** For more information, see the
[micro:bit runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/).

28
docs/reference/control/raise-event.md
View File

@ -3,30 +3,8 @@
Raise an event in the event bus.
```sig
control.raiseEvent(control.eventSourceId(EventBusSource.MICROBIT_ID_BUTTON_A), control.eventValueId(EventBusValue.MICROBIT_EVT_ANY));
```
### Parameters
* ``a``:
* ``b``:
* ``c``:
### Returns
### Example
The following example / This program does something.
```blocks
```
### See also
[bar bas](/reference/foo/bar-bas),
[bar bas](/reference/foo/bar-bas),
[bar bas](/reference/foo/bar-bas)
**This is an advanced API.** For more information, see the
[micro:bit runtime messageBus documentation](https://lancaster-university.github.io/microbit-docs/ubit/messageBus/)