Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/assets/css/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,10 @@ img[src*="#animationUtilsPreview"] {
background-color: rgb(208, 95, 45);
}

.chip-enum {
background-color: rgb(155, 89, 182);
}

.md-content__inner {
word-break: break-word;
}
4 changes: 2 additions & 2 deletions docs/components/connectivity/activity-starter.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The ActivityError event is no longer used. Please use the Screen.ErrorOccurred e

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Activity%20Starter%22,%20%22name%22:%20%22ActivityError%22,%20%22param%22:%20%5B%22message%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|message|<span class="chip chip-text">Text</span>|

Expand All @@ -44,7 +44,7 @@ Event raised after this ActivityStarter returns.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Activity%20Starter%22,%20%22name%22:%20%22After%20Activity%22,%20%22param%22:%20%5B%22result%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|result|<span class="chip chip-text">Text</span>|

Expand Down
6 changes: 3 additions & 3 deletions docs/components/connectivity/arduino.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Triggered after Read function

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Arduino%22,%20%22name%22:%20%22After%20Read%22,%20%22param%22:%20%5B%22success%22,%20%22data%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|success|<span class="chip chip-boolean">Boolean</span>|
|data|<span class="chip chip-text">Text</span>|
Expand All @@ -31,7 +31,7 @@ Default baud rate is 9600 bps

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Arduino%22,%20%22name%22:%20%22Baud%20Rate%22,%20%22output%22:%20false,%20%22param%22:%20%5B%22baud%20Rate%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|baud Rate|<span class="chip chip-number">Number</span>|

Expand Down Expand Up @@ -77,6 +77,6 @@ Write Data to Serial

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Arduino%22,%20%22name%22:%20%22Write%22,%20%22output%22:%20false,%20%22param%22:%20%5B%22data%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|data|<span class="chip chip-text">Text</span>|
16 changes: 8 additions & 8 deletions docs/components/connectivity/bluetooth-admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Event triggers when Pairing has finished.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Admin%22,%20%22name%22:%20%22After%20Pairing%22,%20%22param%22:%20%5B%22address%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|address|<span class="chip chip-text">Text</span>|

Expand All @@ -34,7 +34,7 @@ Event triggers when Scanning has finished.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Admin%22,%20%22name%22:%20%22After%20Scanning%22,%20%22param%22:%20%5B%22paired%20Devices%22,%20%22new%20Devices%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|paired Devices|<span class="chip chip-any">Any</span>|
|new Devices|<span class="chip chip-any">Any</span>|
Expand All @@ -45,7 +45,7 @@ Event triggers when Unpairing has finished.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Admin%22,%20%22name%22:%20%22After%20Unpairing%22,%20%22param%22:%20%5B%22address%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|address|<span class="chip chip-text">Text</span>|

Expand All @@ -55,7 +55,7 @@ Event triggers when an error occurred.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Admin%22,%20%22name%22:%20%22Error%20Occurred%22,%20%22param%22:%20%5B%22message%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|message|<span class="chip chip-text">Text</span>|

Expand All @@ -65,7 +65,7 @@ Event triggers when the bluetooth state changed.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Admin%22,%20%22name%22:%20%22State%20Changed%22,%20%22param%22:%20%5B%22state%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|state|<span class="chip chip-text">Text</span>|

Expand Down Expand Up @@ -105,7 +105,7 @@ Pair Bluetooth device.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Admin%22,%20%22name%22:%20%22Pair%22,%20%22output%22:%20false,%20%22param%22:%20%5B%22address%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|address|<span class="chip chip-text">Text</span>|

Expand Down Expand Up @@ -143,7 +143,7 @@ Unpair Bluetooth device.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Admin%22,%20%22name%22:%20%22Unpairing%22,%20%22output%22:%20false,%20%22param%22:%20%5B%22address%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|address|<span class="chip chip-text">Text</span>|

Expand All @@ -155,7 +155,7 @@ Returns true if the MacAddress is valid.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Admin%22,%20%22name%22:%20%22Validate%20Mac%20Address%22,%20%22output%22:%20true,%20%22param%22:%20%5B%22mac%20Address%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|mac Address|<span class="chip chip-text">Text</span>|

Expand Down
26 changes: 13 additions & 13 deletions docs/components/connectivity/bluetooth-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The BluetoothError event is no longer used. Please use the Screen.ErrorOccurred

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Client%22,%20%22name%22:%20%22BluetoothError%22,%20%22param%22:%20%5B%22function%20Name%22,%20%22message%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|function Name|<span class="chip chip-text">Text</span>|
|message|<span class="chip chip-text">Text</span>|
Expand All @@ -48,7 +48,7 @@ Connect to the Bluetooth device with the specified address and the Serial Port P

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Client%22,%20%22name%22:%20%22Connect%22,%20%22output%22:%20true,%20%22param%22:%20%5B%22address%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|address|<span class="chip chip-text">Text</span>|

Expand All @@ -60,7 +60,7 @@ Connect to the Bluetooth device with the specified address and UUID. Returns tru

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Client%22,%20%22name%22:%20%22Connect%20With%20UUID%22,%20%22output%22:%20true,%20%22param%22:%20%5B%22address%22,%20%22uuid%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|address|<span class="chip chip-text">Text</span>|
|uuid|<span class="chip chip-text">Text</span>|
Expand All @@ -79,7 +79,7 @@ Checks whether the Bluetooth device with the specified address is paired.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Client%22,%20%22name%22:%20%22Is%20Device%20Paired%22,%20%22output%22:%20true,%20%22param%22:%20%5B%22address%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|address|<span class="chip chip-text">Text</span>|

Expand Down Expand Up @@ -115,7 +115,7 @@ Receive multiple signed byte values from the connected Bluetooth device. If numb

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Client%22,%20%22name%22:%20%22Receive%20Signed%20Bytes%22,%20%22output%22:%20true,%20%22param%22:%20%5B%22number%20Of%20Bytes%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|number Of Bytes|<span class="chip chip-number">Number</span>|

Expand All @@ -127,7 +127,7 @@ Receive text from the connected Bluetooth device. If numberOfBytes is less than

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Client%22,%20%22name%22:%20%22Receive%20Text%22,%20%22output%22:%20true,%20%22param%22:%20%5B%22number%20Of%20Bytes%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|number Of Bytes|<span class="chip chip-number">Number</span>|

Expand Down Expand Up @@ -163,7 +163,7 @@ Receive multiple unsigned byte values from the connected Bluetooth device. If nu

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Client%22,%20%22name%22:%20%22Receive%20Unsigned%20Bytes%22,%20%22output%22:%20true,%20%22param%22:%20%5B%22number%20Of%20Bytes%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|number Of Bytes|<span class="chip chip-number">Number</span>|

Expand All @@ -175,7 +175,7 @@ Remove the Name from a Bluetooth Address and Name String.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Client%22,%20%22name%22:%20%22Remove%20Name%20From%20Address%22,%20%22output%22:%20true,%20%22param%22:%20%5B%22address%20And%20Name%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|address And Name|<span class="chip chip-text">Text</span>|

Expand All @@ -185,7 +185,7 @@ Send a 1-byte number to the connected Bluetooth device.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Client%22,%20%22name%22:%20%22Send%201%20Byte%20Number%22,%20%22output%22:%20false,%20%22param%22:%20%5B%22number%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|number|<span class="chip chip-text">Text</span>|

Expand All @@ -195,7 +195,7 @@ Send a 2-byte number to the connected Bluetooth device.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Client%22,%20%22name%22:%20%22Send%202%20Byte%20Number%22,%20%22output%22:%20false,%20%22param%22:%20%5B%22number%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|number|<span class="chip chip-text">Text</span>|

Expand All @@ -205,7 +205,7 @@ Send a 4-byte number to the connected Bluetooth device.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Client%22,%20%22name%22:%20%22Send%204%20Byte%20Number%22,%20%22output%22:%20false,%20%22param%22:%20%5B%22number%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|number|<span class="chip chip-text">Text</span>|

Expand All @@ -215,7 +215,7 @@ Send a list of byte values to the connected Bluetooth device.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Client%22,%20%22name%22:%20%22Send%20Bytes%22,%20%22output%22:%20false,%20%22param%22:%20%5B%22list%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|list|<span class="chip chip-list">List</span>|

Expand All @@ -225,7 +225,7 @@ Send text to the connected Bluetooth device.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Client%22,%20%22name%22:%20%22Send%20Text%22,%20%22output%22:%20false,%20%22param%22:%20%5B%22text%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|text|<span class="chip chip-text">Text</span>|

Expand Down
22 changes: 11 additions & 11 deletions docs/components/connectivity/bluetooth-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The BluetoothError event is no longer used. Please use the Screen.ErrorOccurred

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Server%22,%20%22name%22:%20%22BluetoothError%22,%20%22param%22:%20%5B%22function%20Name%22,%20%22message%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|function Name|<span class="chip chip-text">Text</span>|
|message|<span class="chip chip-text">Text</span>|
Expand All @@ -42,7 +42,7 @@ Accept an incoming connection with the Serial Port Profile (SPP).

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Server%22,%20%22name%22:%20%22Accept%20Connection%22,%20%22output%22:%20false,%20%22param%22:%20%5B%22service%20Name%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|service Name|<span class="chip chip-text">Text</span>|

Expand All @@ -52,7 +52,7 @@ Accept an incoming connection with a specific UUID.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Server%22,%20%22name%22:%20%22Accept%20Connection%20With%20UUID%22,%20%22output%22:%20false,%20%22param%22:%20%5B%22service%20Name%22,%20%22uuid%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|service Name|<span class="chip chip-text">Text</span>|
|uuid|<span class="chip chip-text">Text</span>|
Expand Down Expand Up @@ -103,7 +103,7 @@ Receive multiple signed byte values from the connected Bluetooth device. If numb

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Server%22,%20%22name%22:%20%22Receive%20Signed%20Bytes%22,%20%22output%22:%20true,%20%22param%22:%20%5B%22number%20Of%20Bytes%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|number Of Bytes|<span class="chip chip-number">Number</span>|

Expand All @@ -115,7 +115,7 @@ Receive text from the connected Bluetooth device. If numberOfBytes is less than

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Server%22,%20%22name%22:%20%22Receive%20Text%22,%20%22output%22:%20true,%20%22param%22:%20%5B%22number%20Of%20Bytes%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|number Of Bytes|<span class="chip chip-number">Number</span>|

Expand Down Expand Up @@ -151,7 +151,7 @@ Receive multiple unsigned byte values from the connected Bluetooth device. If nu

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Server%22,%20%22name%22:%20%22Receive%20Unsigned%20Bytes%22,%20%22output%22:%20true,%20%22param%22:%20%5B%22number%20Of%20Bytes%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|number Of Bytes|<span class="chip chip-number">Number</span>|

Expand All @@ -161,7 +161,7 @@ Send a 1-byte number to the connected Bluetooth device.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Server%22,%20%22name%22:%20%22Send%201%20Byte%20Number%22,%20%22output%22:%20false,%20%22param%22:%20%5B%22number%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|number|<span class="chip chip-text">Text</span>|

Expand All @@ -171,7 +171,7 @@ Send a 2-byte number to the connected Bluetooth device.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Server%22,%20%22name%22:%20%22Send%202%20Byte%20Number%22,%20%22output%22:%20false,%20%22param%22:%20%5B%22number%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|number|<span class="chip chip-text">Text</span>|

Expand All @@ -181,7 +181,7 @@ Send a 4-byte number to the connected Bluetooth device.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Server%22,%20%22name%22:%20%22Send%204%20Byte%20Number%22,%20%22output%22:%20false,%20%22param%22:%20%5B%22number%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|number|<span class="chip chip-text">Text</span>|

Expand All @@ -191,7 +191,7 @@ Send a list of byte values to the connected Bluetooth device.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Server%22,%20%22name%22:%20%22Send%20Bytes%22,%20%22output%22:%20false,%20%22param%22:%20%5B%22list%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|list|<span class="chip chip-list">List</span>|

Expand All @@ -201,7 +201,7 @@ Send text to the connected Bluetooth device.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Bluetooth%20Server%22,%20%22name%22:%20%22Send%20Text%22,%20%22output%22:%20false,%20%22param%22:%20%5B%22text%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|text|<span class="chip chip-text">Text</span>|

Expand Down
8 changes: 4 additions & 4 deletions docs/components/connectivity/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Event to detect if the download is successful finished. You can use the "filePat

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Download%22,%20%22name%22:%20%22Download%20Complete%22,%20%22param%22:%20%5B%22file%20Path%22,%20%22file%20Name%22,%20%22file%20Size%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|file Path|<span class="chip chip-text">Text</span>|
|file Name|<span class="chip chip-text">Text</span>|
Expand All @@ -35,7 +35,7 @@ Event to detect file size is ready to be used.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Download%22,%20%22name%22:%20%22Got%20File%20Size%22,%20%22param%22:%20%5B%22size%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|size|<span class="chip chip-number">Number</span>|

Expand All @@ -51,7 +51,7 @@ Get the progress (in percentage) of the current download task.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22Download%22,%20%22name%22:%20%22On%20Download%20Progress%20Changed%22,%20%22param%22:%20%5B%22progress%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|progress|<span class="chip chip-number">Number</span>|

Expand All @@ -69,7 +69,7 @@ Get the file size (in bytes) of a file that is stored online or on your device.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22Download%22,%20%22name%22:%20%22Get%20File%20Size%22,%20%22output%22:%20false,%20%22param%22:%20%5B%22path%22%5D%7D"></div>

| Params | []() |
| Param | Type |
|--------|------|
|path|<span class="chip chip-text">Text</span>|

Expand Down
Loading
Loading