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
2 changes: 1 addition & 1 deletion website/md-docs/api-overview/constants/key_events.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Couple of examples:
* a longer pres on key would generate: `FIRST`, `LONG`, `BREAK`
* even longer press: `FIRST`, `LONG`, `REPEAT,`REPEAT, ..., `BREAK`

This normal key event sequence can be altered with the [killEvents(key)](../../api-reference/key-inputs/runtime-kill-events.md) function. Any time this function is called (after the `FIRST` event) all further key events for this key will be suppressed until the next key press of this key. Examples:
This normal key event sequence can be altered with the [killEvents(key)](../../api-reference/runtime-kill-events.md) function. Any time this function is called (after the `FIRST` event) all further key events for this key will be suppressed until the next key press of this key. Examples:

* kill immediately after the key press would generate: `FIRST`
* kill after the long key press would generate: `FIRST`, `LONG`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Each model can have up to nine Main Views, with up to 8 widgets per screen, depe
All widget scripts on the SD card are loaded into memory when the model is selected, even widgets that are not used. This has the side effect that any global functions defined in a widget script will always be available to other widget scripts. It also means that any Widget Script placed in proper location on the SD card will consume part of the radio's memory - even if it is not being used. 

!!! warning
 It is important to either keep Widget Scripts small, or to use Lua's [loadScript()](../../api-reference/lua-scripts/runtime-load-script.md) function to load code dynamically
 It is important to either keep Widget Scripts small, or to use Lua's [loadScript()](../../api-reference/runtime-load-script.md) function to load code dynamically

Script executes until:

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-draw-annulus.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Draw an arc
| `r2` | yes | `integer` | radii of the inside and outside of the annulus |
| `start` | yes | `integer` | start and end of the annulus |
| `end` | yes | `integer` | start and end of the annulus |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) |

## Returns

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-draw-arc.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Draw an arc
| `r` | yes | `integer` | radius |
| `start` | yes | `integer` | start and end of the arc |
| `end` | yes | `integer` | start and end of the arc |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) |

## Returns

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Displays a bitmap pattern pie at (x,y)
| `y` | yes | `integer` | starting coordinates |
| `startAngle` | yes | `integer` | Start angle |
| `endAngle` | yes | `integer` | End angle |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) |

## Returns

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-draw-bitmap-pattern.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Displays a bitmap pattern at (x,y)
| `bitmap` | yes | `pointer` | point to a bitmap previously opened with Bitmap.open() |
| `x` | yes | `integer` | starting coordinates |
| `y` | yes | `integer` | starting coordinates |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) |

## Returns

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-draw-channel.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Display a telemetry value at (x,y)
| `x` | yes | `integer` | starting coordinate |
| `y` | yes | `integer` | starting coordinate |
| `source` | yes | `integer|string` | can be a source identifier (number) or a source name (string). See getValue() |
| `flags` | yes | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | yes | `integer` | please see [Lcd functions overview](display-lcd.md) |

## Returns

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-draw-circle.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Draw a circle at (x, y) of specified radius
| `x` | yes | `integer` | center position |
| `y` | yes | `integer` | center position |
| `r` | yes | `integer` | radius in pixels |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) |

## Returns

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-draw-filled-circle.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Draw a filled circle at (x, y) of specified radius
| `x` | yes | `integer` | center position |
| `y` | yes | `integer` | center position |
| `r` | yes | `integer` | radius in pixels |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) |

## Returns

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-draw-filled-rectangle.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Draw a solid rectangle from top left corner (x,y) of specified width and height
| `y` | yes | `integer` | top left corner position |
| `w` | yes | `integer` | width in pixels |
| `h` | yes | `integer` | height in pixels |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) |
| `opacity` | no | `integer` | opacity defaults to 0 (only on radios with color display) |

## Returns
Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-draw-filled-triangle.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Draw a filled triangle
| `y2` | yes | `integer` | coordinates of the three vertices |
| `x3` | yes | `integer` | coordinates of the three vertices |
| `y3` | yes | `integer` | coordinates of the three vertices |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) |

## Returns

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-draw-gauge.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Draw a simple gauge that is filled based upon fill value
| `h` | yes | `integer` | height in pixels |
| `fill` | yes | `integer` | amount of fill to apply |
| `maxfill` | yes | `integer` | total value of fill |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) |

## Returns

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-draw-hud-rectangle.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Draw a rectangle in perspective
| `xmax` | yes | `integer` | the limits of the rectangle |
| `ymin` | yes | `integer` | the limits of the rectangle |
| `ymax` | yes | `integer` | the limits of the rectangle |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) |

## Returns

Expand Down
4 changes: 2 additions & 2 deletions website/md-docs/api-reference/lcd-draw-line-with-clipping.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ Draw a line only inside a rectangle
| `xmax` | yes | `integer` | the limits of the rectangle inside which the line is drawn |
| `ymin` | yes | `integer` | the limits of the rectangle inside which the line is drawn |
| `ymax` | yes | `integer` | the limits of the rectangle inside which the line is drawn |
| `pattern` | yes | `FORCE` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `pattern` | yes | `FORCE` | please see [Lcd functions overview](display-lcd.md) |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) |

## Returns

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-draw-number.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Display a number at (x,y)
| `x` | yes | `integer` | starting coordinate |
| `y` | yes | `integer` | starting coordinate |
| `value` | yes | `integer` | value to display |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) |
| `inversColor` | no | `string` | overrides the inverse text color for INVERS |

## Returns
Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-draw-pie.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Draw a pie slice
| `r` | yes | `integer` | radius |
| `start` | yes | `integer` | start and end of the pie slice |
| `end` | yes | `integer` | start and end of the pie slice |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) |

## Returns

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-draw-point.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Draw a single pixel at (x,y) position
| --- | --- | --- | --- |
| `x` | yes | `integer` | x position |
| `y` | yes | `integer` | y position |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) |

## Returns

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-draw-rectangle.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Draw a rectangle from top left corner (x,y) of specified width and height
| `y` | yes | `integer` | top left corner position |
| `w` | yes | `integer` | width in pixels |
| `h` | yes | `integer` | height in pixels |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) |
| `t` | no | `integer` | thickness in pixels, defaults to 1 (only on radios with color display) |
| `opacity` | no | `integer` | opacity defaults to 0 (only on radios with color display) |

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-draw-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Displays the name of the corresponding input as defined by the source at (x,y)
| `x` | yes | `integer` | starting coordinate |
| `y` | yes | `integer` | starting coordinate |
| `source` | yes | `integer` | source index |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) |

## Returns

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-draw-switch.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Draw a text representation of switch at (x,y)
| `x` | yes | `integer` | starting coordinate |
| `y` | yes | `integer` | starting coordinate |
| `switch` | yes | `integer` | number of switch to display, negative number displays negated switch |
| `flags` | yes | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html), only SMLSIZE, BLINK and INVERS. |
| `flags` | yes | `integer` | please see [Lcd functions overview](display-lcd.md), only SMLSIZE, BLINK and INVERS. |

## Returns

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-draw-text-lines.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Draw text inside rectangle (x,y,w,h) with line breaks
| `w` | yes | `integer` | width and height of bounding rectangle |
| `h` | yes | `integer` | width and height of bounding rectangle |
| `text` | yes | `string` | text to display |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) for drawing flags and colors, and [Appendix](../../part_vii_-_appendix/fonts.md) for available characters in each font set. RIGHT, CENTER and VCENTER are not implemented. |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) for drawing flags and colors, and [Appendix](../api-overview/fonts.md) for available characters in each font set. RIGHT, CENTER and VCENTER are not implemented. |

## Returns

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-draw-text.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Draw a text beginning at (x,y)
| `x` | yes | `integer` | starting coordinate |
| `y` | yes | `integer` | starting coordinate |
| `text` | yes | `string` | text to display |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) for drawing flags and colors, and [Appendix](../../part_vii_-_appendix/fonts.md) for available characters in each font set. |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) for drawing flags and colors, and [Appendix](../api-overview/fonts.md) for available characters in each font set. |
| `inversColor` | no | `string` | overrides the inverse text color for INVERS |

## Returns
Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-draw-timer.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Display a value formatted as time at (x,y)
| `x` | yes | `integer` | starting coordinate |
| `y` | yes | `integer` | starting coordinate |
| `value` | yes | `integer` | time in seconds |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) |
| `inversColor` | no | `string` | overrides the inverse text color for INVERS |

## Returns
Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-draw-triangle.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Draw a triangle
| `y2` | yes | `integer` | coordinates of the three vertices |
| `x3` | yes | `integer` | coordinates of the three vertices |
| `y3` | yes | `integer` | coordinates of the three vertices |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) |

## Returns

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-get-color.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Get the color value from flags

| Name | Req | Type | Description |
| --- | --- | --- | --- |
| `flags` | yes | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | yes | `integer` | please see [Lcd functions overview](display-lcd.md) |

## Returns

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-invert-rect.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Invert a rectangle zone from top left corner (x,y) of specified width and height
| `y` | yes | `integer` | top left corner position |
| `w` | yes | `integer` | width in pixels |
| `h` | yes | `integer` | height in pixels |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) |

## Returns

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-set-color.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

`lcd.setColor(colorIndex, color)`

Change an indexed color (theme colors and CUSTOM_COLOR). Please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html#color-constants)
Change an indexed color (theme colors and CUSTOM_COLOR). Please see [Lcd functions overview](../api-overview/constants/color-constants.md#indexed-colors)

## Parameters

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/lcd-size-text.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Get the width and height of a text string drawn with flags
| Name | Req | Type | Description |
| --- | --- | --- | --- |
| `text` | yes | `string` | |
| `flags` | no | `integer` | please see [Lcd functions overview](../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) |
| `flags` | no | `integer` | please see [Lcd functions overview](display-lcd.md) |

## Returns

Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/runtime-get-field-info.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Return detailed information about field (source)

| Name | Type | Description |
| --- | --- | --- |
| `-` | `table` | information about requested field, table elements: * `id` (number) field identifier * `name` (string) field name * `desc` (string) field description * `unit` (number) unit identifier [Full list](../appendix/units.html) |
| `-` | `table` | information about requested field, table elements: * `id` (number) field identifier * `name` (string) field name * `desc` (string) field description * `unit` (number) unit identifier [Full list](../api-overview/constants/units.md) |
| `-` | `nil` | the requested field was not found |

## Availability
Expand Down
2 changes: 1 addition & 1 deletion website/md-docs/api-reference/runtime-play-number.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Play a numerical value (text to speech)
| Name | Req | Type | Description |
| --- | --- | --- | --- |
| `value` | yes | `integer` | number to play. Value is interpreted as integer. |
| `unit` | yes | `integer` | unit identifier [Full list]((../appendix/units.html)) |
| `unit` | yes | `integer` | unit identifier [Full list](../api-overview/constants/units.md) |
| `attributes` | no | `integer` | possible values: * `0 or not present` plays integral part of the number (for a number 123 it plays 123) * `PREC1` plays a number with one decimal place (for a number 123 it plays 12.3) * `PREC2` plays a number with two decimal places (for a number 123 it plays 1.23) |

## Returns
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
| `subID` | yes | `integer` | subID of the sensor, usually 0, valid range is from 0 to 7 |
| `instance` | yes | `integer` | instance of the sensor (SensorID), valid range is from 0 to 0xFF |
| `value` | yes | `integer` | fed to the sensor |
| `unit` | no | `unit_type` | unit of the sensor [Full list](../../appendix/units.html) |
| `unit` | no | `unit_type` | unit of the sensor [Full list](../api-overview/constants/units.md) |
| `precision` | no | `prec_type` | the precision of the sensor * `0 or not present` no decimal precision. * `!= 0` value is divided by 10^precision, e.g. value=1000, prec=2 => 10.00. |
| `name` | no | `string` | Name of the sensor if it does not yet exist (4 chars). * `not present` Name defaults to the Id. * `present` Sensor takes name of the argument. Argument must have name surrounded by quotes: e.g., "Name" |

Expand Down
Loading