From c55716e148c46d6597abf6b9f875303038218a78 Mon Sep 17 00:00:00 2001 From: Ron Hale-Evans Date: Thu, 21 Jul 2016 13:29:59 -0700 Subject: [PATCH] Control pages now link to Lancaster --- docs/reference/control/device-name.md | 27 ++-------------- .../reference/control/device-serial-number.md | 28 ++-------------- docs/reference/control/event-source-id.md | 32 +++---------------- docs/reference/control/event-timestamp.md | 28 ++-------------- docs/reference/control/event-value-id.md | 30 +++-------------- docs/reference/control/event-value.md | 26 ++------------- docs/reference/control/on-event.md | 27 ++-------------- docs/reference/control/raise-event.md | 28 ++-------------- 8 files changed, 28 insertions(+), 198 deletions(-) diff --git a/docs/reference/control/device-name.md b/docs/reference/control/device-name.md index 46594ba9..566b0e07 100644 --- a/docs/reference/control/device-name.md +++ b/docs/reference/control/device-name.md @@ -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/). diff --git a/docs/reference/control/device-serial-number.md b/docs/reference/control/device-serial-number.md index 13c2e1a7..abb4dd20 100644 --- a/docs/reference/control/device-serial-number.md +++ b/docs/reference/control/device-serial-number.md @@ -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/). diff --git a/docs/reference/control/event-source-id.md b/docs/reference/control/event-source-id.md index 5c210b4d..af44ba9d 100644 --- a/docs/reference/control/event-source-id.md +++ b/docs/reference/control/event-source-id.md @@ -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/) diff --git a/docs/reference/control/event-timestamp.md b/docs/reference/control/event-timestamp.md index 5a68fc94..5129b9ad 100644 --- a/docs/reference/control/event-timestamp.md +++ b/docs/reference/control/event-timestamp.md @@ -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/). diff --git a/docs/reference/control/event-value-id.md b/docs/reference/control/event-value-id.md index 5c210b4d..8153a7f0 100644 --- a/docs/reference/control/event-value-id.md +++ b/docs/reference/control/event-value-id.md @@ -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/). diff --git a/docs/reference/control/event-value.md b/docs/reference/control/event-value.md index 28078c39..46b60081 100644 --- a/docs/reference/control/event-value.md +++ b/docs/reference/control/event-value.md @@ -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/). diff --git a/docs/reference/control/on-event.md b/docs/reference/control/on-event.md index 610233c2..a95dd5d8 100644 --- a/docs/reference/control/on-event.md +++ b/docs/reference/control/on-event.md @@ -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/). diff --git a/docs/reference/control/raise-event.md b/docs/reference/control/raise-event.md index 010b2e8a..f9a8a50c 100644 --- a/docs/reference/control/raise-event.md +++ b/docs/reference/control/raise-event.md @@ -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/)