mirror of
https://github.com/Next-Flip/Momentum-Firmware.git
synced 2026-05-23 05:24:46 -07:00
Merge remote-tracking branch 'OFW/dev' into dev
This commit is contained in:
@@ -72,7 +72,7 @@
|
||||
* @brief Checks compatibility between the script and the JS SDK that the
|
||||
* firmware provides
|
||||
*
|
||||
* @note You're looking at JS SDK v0.3
|
||||
* @note You're looking at JS SDK v1.0
|
||||
*
|
||||
* @param expectedMajor JS SDK major version expected by the script
|
||||
* @param expectedMinor JS SDK minor version expected by the script
|
||||
@@ -92,7 +92,7 @@ declare function sdkCompatibilityStatus(expectedMajor: number, expectedMinor: nu
|
||||
* @brief Checks compatibility between the script and the JS SDK that the
|
||||
* firmware provides in a boolean fashion
|
||||
*
|
||||
* @note You're looking at JS SDK v0.3
|
||||
* @note You're looking at JS SDK v1.0
|
||||
*
|
||||
* @param expectedMajor JS SDK major version expected by the script
|
||||
* @param expectedMinor JS SDK minor version expected by the script
|
||||
@@ -105,7 +105,7 @@ declare function isSdkCompatible(expectedMajor: number, expectedMinor: number):
|
||||
* @brief Asks the user whether to continue executing the script if the versions
|
||||
* are not compatible. Does nothing if they are.
|
||||
*
|
||||
* @note You're looking at JS SDK v0.3
|
||||
* @note You're looking at JS SDK v1.0
|
||||
*
|
||||
* @param expectedMajor JS SDK major version expected by the script
|
||||
* @param expectedMinor JS SDK minor version expected by the script
|
||||
|
||||
@@ -80,6 +80,7 @@ export interface Pin {
|
||||
* PWM-related methods on this pin will throw an error when called.
|
||||
* @note On Flipper Zero only pins PA4 and PA7 support PWM
|
||||
* @version Added in JS SDK 0.2, extra feature `"gpio-pwm"`
|
||||
* @version Baseline since JS SDK 1.0
|
||||
*/
|
||||
isPwmSupported(): boolean;
|
||||
/**
|
||||
@@ -89,18 +90,21 @@ export interface Pin {
|
||||
* @param freq Frequency in Hz
|
||||
* @param duty Duty cycle in %
|
||||
* @version Added in JS SDK 0.2, extra feature `"gpio-pwm"`
|
||||
* @version Baseline since JS SDK 1.0
|
||||
*/
|
||||
pwmWrite(freq: number, duty: number): void;
|
||||
/**
|
||||
* Determines whether PWM is running. Throws an error if PWM is not
|
||||
* supported on this pin.
|
||||
* @version Added in JS SDK 0.2, extra feature `"gpio-pwm"`
|
||||
* @version Baseline since JS SDK 1.0
|
||||
*/
|
||||
isPwmRunning(): boolean;
|
||||
/**
|
||||
* Stops PWM. Does not restore previous pin configuration. Throws an error
|
||||
* if PWM is not supported on this pin.
|
||||
* @version Added in JS SDK 0.2, extra feature `"gpio-pwm"`
|
||||
* @version Baseline since JS SDK 1.0
|
||||
*/
|
||||
pwmStop(): void;
|
||||
}
|
||||
|
||||
@@ -7,6 +7,7 @@ export type IconData = symbol & { "__tag__": "icon" };
|
||||
* Gets a built-in firmware icon for use in GUI
|
||||
* @param icon Name of the icon
|
||||
* @version Added in JS SDK 0.2, extra feature `"gui-widget"`
|
||||
* @version Baseline since JS SDK 1.0
|
||||
*/
|
||||
export declare function getBuiltin(icon: BuiltinIcon): IconData;
|
||||
|
||||
@@ -14,5 +15,6 @@ export declare function getBuiltin(icon: BuiltinIcon): IconData;
|
||||
* Loads a .fxbm icon (XBM Flipper sprite, from flipperzero-game-engine) for use in GUI
|
||||
* @param path Path to the .fxbm file
|
||||
* @version Added in JS SDK 0.3, extra feature `"gui-widget-extras"`
|
||||
* @version Baseline since JS SDK 1.0
|
||||
*/
|
||||
export declare function loadFxbm(path: string): IconData;
|
||||
|
||||
@@ -133,17 +133,20 @@ export declare class View<Props extends Properties, Child> {
|
||||
* Adds a child to the View
|
||||
* @param child Child to add
|
||||
* @version Added in JS SDK 0.2, extra feature `"gui-widget"`
|
||||
* @version Baseline since JS SDK 1.0
|
||||
*/
|
||||
addChild<C extends Child>(child: C): void;
|
||||
/**
|
||||
* Removes all children from the View
|
||||
* @version Added in JS SDK 0.2, extra feature `"gui-widget"`
|
||||
* @version Baseline since JS SDK 1.0
|
||||
*/
|
||||
resetChildren(): void;
|
||||
/**
|
||||
* Removes all previous children from the View and assigns new children
|
||||
* @param children The list of children to assign
|
||||
* @version Added in JS SDK 0.2, extra feature `"gui-widget"`
|
||||
* @version Baseline since JS SDK 1.0
|
||||
*/
|
||||
setChildren(children: Child[]): void;
|
||||
}
|
||||
@@ -158,7 +161,9 @@ export declare class ViewFactory<Props extends Properties, Child, V extends View
|
||||
* Create view instance with custom values, can be changed later with set()
|
||||
* @param initial Dictionary of property names to values
|
||||
* @param children Optional list of children to add to the view
|
||||
* @version Added in JS SDK 0.1; amended in JS SDK 0.2, extra feature `"gui-widget"`
|
||||
* @version Added in JS SDK 0.1
|
||||
* @version Amended in JS SDK 0.2, extra feature `"gui-widget"`
|
||||
* @version Baseline since JS SDK 1.0
|
||||
*/
|
||||
makeWith(initial: Partial<Props>, children?: Child[]): V;
|
||||
}
|
||||
|
||||
@@ -23,6 +23,7 @@
|
||||
* This view has the elements as its children.
|
||||
*
|
||||
* @version Added in JS SDK 0.2, extra feature `"gui-widget"`
|
||||
* @version Baseline since JS SDK 1.0
|
||||
* @module
|
||||
*/
|
||||
|
||||
@@ -42,9 +43,21 @@ type TextBoxElement = { element: "text_box", stripToDots: boolean } & Position &
|
||||
type TextScrollElement = { element: "text_scroll" } & Position & Size & Text;
|
||||
type ButtonElement = { element: "button", button: "left" | "center" | "right" } & Text;
|
||||
type IconElement = { element: "icon", iconData: IconData } & Position;
|
||||
type RectElement = { element: "rect", radius: number, fill: boolean } & Position & Size; /** @version Amended in JS SDK 0.3, extra feature `"gui-widget-extras"` */
|
||||
type CircleElement = { element: "circle", radius: number, fill: boolean } & Position; /** @version Added in JS SDK 0.3, extra feature `"gui-widget-extras"` */
|
||||
type LineElement = { element: "line", x1: number, y1: number, x2: number, y2: number }; /** @version Added in JS SDK 0.3, extra feature `"gui-widget-extras"` */
|
||||
/**
|
||||
* @version Amended in JS SDK 0.3, extra feature `"gui-widget-extras"`
|
||||
* @version Baseline since JS SDK 1.0
|
||||
* */
|
||||
type RectElement = { element: "rect", radius: number, fill: boolean } & Position & Size;
|
||||
/**
|
||||
* @version Added in JS SDK 0.3, extra feature `"gui-widget-extras"`
|
||||
* @version Baseline since JS SDK 1.0
|
||||
* */
|
||||
type CircleElement = { element: "circle", radius: number, fill: boolean } & Position;
|
||||
/**
|
||||
* @version Added in JS SDK 0.3, extra feature `"gui-widget-extras"`
|
||||
* @version Baseline since JS SDK 1.0
|
||||
* */
|
||||
type LineElement = { element: "line", x1: number, y1: number, x2: number, y2: number };
|
||||
|
||||
type Element = StringMultilineElement
|
||||
| StringElement
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@darkflippers/fz-sdk-ul",
|
||||
"version": "0.3.0",
|
||||
"version": "1.0.0",
|
||||
"description": "Type declarations and documentation for native JS modules available on Unleashed Custom Firmware for Flipper Zero",
|
||||
"keywords": [
|
||||
"unleashed",
|
||||
|
||||
@@ -29,6 +29,7 @@ export interface Framing {
|
||||
* @param framing See `Framing` type
|
||||
* @version Added in JS SDK 0.1
|
||||
* @version Added `framing` parameter in JS SDK 0.3, extra feature `"serial-framing"`
|
||||
* @version Baseline since JS SDK 1.0
|
||||
*/
|
||||
export declare function setup(port: "lpuart" | "usart", baudRate: number, framing?: Framing): void;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user