Mirror/Momentum-Firmware
1
0
Fork 0
mirror of https://github.com/Next-Flip/Momentum-Firmware.git synced 2026-05-22 05:14:46 -07:00
Code Issues Packages Projects Releases Wiki Activity

[FL-3918] Full-fledged JS SDK + npm packages (#3963)

Browse Source 
* feat: js sdk
* refactor: move js back where it belongs
* docs: generate docs using typedoc
* feat: sdk versioning scheme
* ci: silence pvs warning
* docs: bring back old incomplete js docs
* style: readAnalog naming
* fix: rename script compatibility screens

Co-authored-by: あく <alleteam@gmail.com>
This commit is contained in:
Anna Antonenko
2024-10-31 05:42:57 +03:00
committed by GitHub
parent e4c8270824
commit 85e5642b2a
62 changed files with 3150 additions and 419 deletions
Download Patch File Download Diff File Expand all files Collapse all files

86
applications/system/js_app/packages/fz-sdk/gpio/index.d.ts vendored Normal file
View File

@@ -0,0 +1,86 @@
/**
* Module for accessing the GPIO (General Purpose Input/Output) ports
*
* ```js
* let eventLoop = require("event_loop");
* let gpio = require("gpio");
* ```
*
* This module depends on the `event_loop` module, so it _must_ only be imported
* after `event_loop` is imported.
*
* # Example
* ```js
* let eventLoop = require("event_loop");
* let gpio = require("gpio");
*
* let led = gpio.get("pc3");
* led.init({ direction: "out", outMode: "push_pull" });
*
* led.write(true);
* delay(1000);
* led.write(false);
* delay(1000);
* ```
*
* @version Added in JS SDK 0.1
* @module
*/
import type { Contract } from "../event_loop";
/**
* @version Added in JS SDK 0.1
*/
export interface Mode {
direction: "in" | "out";
outMode?: "push_pull" | "open_drain";
inMode?: "analog" | "plain_digital" | "interrupt" | "event";
edge?: "rising" | "falling" | "both";
pull?: "up" | "down";
}
/**
* @version Added in JS SDK 0.1
*/
export interface Pin {
/**
* Configures a pin. This may be done several times.
* @param mode Pin configuration object
* @version Added in JS SDK 0.1
*/
init(mode: Mode): void;
/**
* Sets the output value of a pin if it's been configured with
* `direction: "out"`.
* @param value Logic value to output
* @version Added in JS SDK 0.1
*/
write(value: boolean): void;
/**
* Gets the input value of a pin if it's been configured with
* `direction: "in"`, but not `inMode: "analog"`.
* @version Added in JS SDK 0.1
*/
read(): boolean;
/**
* Gets the input voltage of a pin in millivolts if it's been configured
* with `direction: "in"` and `inMode: "analog"`
* @version Added in JS SDK 0.1
*/
readAnalog(): number;
/**
* Returns an `event_loop` event that can be used to listen to interrupts,
* as configured by `init`
* @version Added in JS SDK 0.1
*/
interrupt(): Contract;
}
/**
* Returns an object that can be used to manage a GPIO pin. For the list of
* available pins, see https://docs.flipper.net/gpio-and-modules#miFsS
* @param pin Pin name (e.g. `"PC3"`) or number (e.g. `7`)
* @version Added in JS SDK 0.1
*/
export function get(pin: string | number): Pin;