LinkJS

https://www.yuque.com/linkpi/linkjs
Admin
LinkJS is a framework and toolset built on LinkSDK for developing embedded audio and video products...
Tokens:13,831
Snippets:128
Trust Score:9.7
Update:9 months ago
Show doc for...
Tokens:
Raw
### Initialize and Start Video Output in LinkJS

Source: https://www.yuque.com/linkpi/linkjs/aq1o6glahhbwftoa_language=en-us

This code snippet demonstrates how to initialize and start a video output interface using LinkJS. It involves creating an output object and starting it with a specified interface name.

```LinkJS
IMPORTLCDFROM"CORE/LCD/LCD.J
OVERLAYLINK.CREATEOVERLAY2)
VARNAME=LINK.GETINTERFACE(O);
VOELINK.CREATEOUTPUTVO)
VI.START(INTERFACE:NAMEY);
```

--------------------------------

### LinkPi Initialization and Video Output in LMAIN.JS

Source: https://www.yuque.com/linkpi/linkjs/aq1o6glahhbwftoa

This snippet initializes LinkPi, sets up an overlay, and starts a video output stream. It depends on the CORE/LCD/LCD.J and OVERLAYLINK modules. The function MAIN is the entry point for the script.

```javascript
IMPORTLCDFROM"CORE/LCD/LCD.J"
OVERLAYLINK.CREATEOVERLAY2)
VARNAME=LINK.GETINTERFACE(O);
VOELINK.CREATEOUTPUTVO)
VI.START(INTERFACE:NAMEY);
456ENGINESTART(VER91ONV1.1.0,P1DF243B8)
VIELINK.CREATE"INPUTVI");
[202601-0915H02:56
VARVI,OVERLAY,VO;
//视频输出
[2026-01-0915:02:564
FUNCTIONMAIN
VARCONFIG;
系统管理员
LINKPI
OVERLAYSTART();
VO.START(;
UU山.LINKPICN
灵派科技
LMAIN.JS
//文字叠加
T2026-0109
PROJECTJSON
[2026-01-0915:0
HELLOWORLD
口IMG
口CONFIG
HELLOWORLD
ADMIN
/视频输入
系统日志
1080
20元1080P60G0
[2026-01-09
2卓
:02:5670
H直0
1WET
ICORE
56.4571TINKSDK4.4.0BUI1D2025122330769
2026-01-09
1TO
SCRIPT
口5
P6
入0
2026-0109
E
GM
0+G0
645
15:02:56.711]PROIECT:"HELLOWORLD"VERSION;"1.0.0"
1502:5
1O
17
0
14
15
C5
13
3
11
12
5
16
15:0
三
S
4
E
6
口
9
```

--------------------------------

### Start Main Application Logic in LinkJS

Source: https://www.yuque.com/linkpi/linkjs/aq1o6glahhbwftoa_language=zh-cn

This code segment shows the initialization of the main application function, including starting overlay and video output. It represents the core execution flow of the LinkJS application.

```javascript
//视频输出
[2026-01-0915:02:56
FUNCTIONMAIN
VARCONFIG;
系统管理员
LINKPI
OVERLAYSTART();
VO.START(;
```

--------------------------------

### Main Function and System Initialization in LinkJS

Source: https://www.yuque.com/linkpi/linkjs/aq1o6glahhbwftoa_language=en-us

This snippet shows the main function structure and system initialization process in LinkJS. It includes starting overlays, voice output, and the main engine with version information.

```LinkJS
[202601-0915H02:56
VARVI,OVERLAY,VO;
//视频输出
[2026-01-0915:02:56
FUNCTIONMAIN
VARCONFIG;
系统管理员
LINKPI
OVERLAYSTART();
VO.START(;
UU山.LINKPICN
灵派科技
LMAIN.JS
//文字叠加
T2026-0109
PROJECTJSON
[2026-01-0915:0
HELLOWORLD
口IMG
口CONFIG
HELLOWORLD
ADMIN
/视频输入
系统日志
1080
20元1080P60G0
[2026-01-09
2卓
:02:5670
H直0
1WET
ICORE
56.4571TINKSDK4.4.0BUI1D2025122330769
2026-01-09
1TO
SCRIPT
口5
P6
入0
2026-0109
E
GM
0+G0
645
15:02:56.711]PROIECT:"HELLOWORLD"VERSION;"1.0.0"
1502:5
1O
17
0
14
15
C5
13
3
11
12
5
16
15:0
三
S
4
E
6
口
9
```

--------------------------------

### Link.create(className, name)

Source: https://www.yuque.com/linkpi/linkjs/wg8xz6zswrnkudol_language=zh-cn

Creates an instance of a LinkSDK module object. This object is used for subsequent operations like parameter configuration, starting, and stopping modules.

```APIDOC
## POST /link/create

### Description
Creates a LinkSDK module object that can be used for subsequent parameter configuration, starting, and stopping operations.

### Method
POST

### Endpoint
/link/create

### Parameters
#### Query Parameters
- **className** (string) - Required - The name of the module class to create.
- **name** (string) - Optional - The name to assign to the instance. Can be omitted.

### Request Example
```json
{
  "className": "ModuleName",
  "name": "MyModuleInstance"
}
```

### Response
#### Success Response (200)
- **linkObject** (object) - A LinkObject representing the created module instance.
```

--------------------------------

### Link.create(className, name)

Source: https://www.yuque.com/linkpi/linkjs/wg8xz6zswrnkudol

Creates an instance of a LinkSDK module object. This object can then be used for subsequent operations such as configuring parameters, starting, or stopping the module.

```APIDOC
## POST Link.create(className, name)

### Description
Creates an instance of a LinkSDK module object. This object can then be used for subsequent operations such as configuring parameters, starting, or stopping the module. The 'name' parameter is optional.

### Method
POST

### Endpoint
/link/create

### Parameters
#### Request Body
- **className** (string) - Required - The name of the module to create.
- **name** (string) - Optional - A custom name for the module instance.

### Request Example
```json
{
  "method": "Link.create",
  "params": [
    "moduleName",
    "instanceName"
  ]
}
```

### Response
#### Success Response (200)
- **linkObject** (object) - The created LinkObject instance.

#### Response Example
```json
{
  "result": {
    "objectId": "unique_object_id"
  }
}
```
```

--------------------------------

### Create LinkSDK Module Object with Link.create()

Source: https://www.yuque.com/linkpi/linkjs/wg8xz6zswrnkudol_language=en-us

Creates an instance of a LinkSDK module object, which is necessary for subsequent operations like parameter configuration, starting, and stopping modules. Accepts the module class name and an optional instance name. Returns a LinkObject.

```javascript
Link.create(className, name)
```

--------------------------------

### Get Device Interface List with Link.getInterface()

Source: https://www.yuque.com/linkpi/linkjs/wg8xz6zswrnkudol_language=en-us

Retrieves a list of available interface names on the current device. This is often used to dynamically adapt to different device models by automatically selecting the first interface. For specific device development, hardcoding the interface name is also an option. Returns an array of interface names.

```javascript
Link.getInterface()
```

--------------------------------

### Initialize Core Modules and Interfaces in LinkJS

Source: https://www.yuque.com/linkpi/linkjs/aq1o6glahhbwftoa_language=zh-cn

This snippet demonstrates how to import essential modules like LCD and Overlay, create interfaces, and initialize input/output streams. It sets up the basic communication channels required for the application.

```javascript
IMPORTLCDFROM"CORE/LCD/LCD.J
OVERLAYLINK.CREATEOVERLAY2)
VARNAME=LINK.GETINTERFACE(O);
VOELINK.CREATEOUTPUTVO)
VI.START(INTERFACE:NAMEY);
456ENGINESTART(VER91ONV1.1.0,P1DF243B8)
VIELINK.CREATE"INPUTVI");
```

--------------------------------

### Project Configuration (project.json)

Source: https://www.yuque.com/linkpi/linkjs/shbzrsl10zy7pptz_language=en-us

Defines project configuration such as name, version, and root directories for config, script, and web resources. This file is automatically generated when a new project is created and usually requires no manual modification.

```json
{
"projectName": "LCD",
"version": "1.0.0",
"config": {
"root": "config"
},
"script": {
"root": "script",
"entryFile": "main.js",
"entryFunc": "main",
"coreVer": "1.1.2"
},
"web": {
"root": "web",
"entryPage": "index.php"
}
}
```

--------------------------------

### Link.getInterface()

Source: https://www.yuque.com/linkpi/linkjs/wg8xz6zswrnkudol

Retrieves a list of available interfaces on the current device. This is often used to automatically detect and use the first available interface for broad device compatibility.

```APIDOC
## GET Link.getInterface()

### Description
Retrieves a list of available interfaces on the current device. This is often used to automatically detect and use the first available interface for broad device compatibility.

### Method
GET

### Endpoint
/link/getInterface

### Parameters
#### Query Parameters
None

### Request Example
```json
{
  "method": "Link.getInterface"
}
```

### Response
#### Success Response (200)
- **interfaces** (array) - A list of interface names available on the device.

#### Response Example
```json
{
  "result": [
    "interface1",
    "interface2"
  ]
}
```
```

--------------------------------

### Link.getInterface()

Source: https://www.yuque.com/linkpi/linkjs/wg8xz6zswrnkudol_language=zh-cn

Retrieves a list of interface names for the current device. This is often used to automatically adapt to different device models.

```APIDOC
## GET /link/getInterface

### Description
Retrieves a list of available interface names on the current device. This list is used for the `interface` property in modules like vi ai.

### Method
GET

### Endpoint
/link/getInterface

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **interfaces** (array) - A list of strings, where each string is an interface name.
```

--------------------------------

### Project and System Information in LinkJS

Source: https://www.yuque.com/linkpi/linkjs/aq1o6glahhbwftoa_language=zh-cn

This snippet displays timestamped project and version information, along with SDK build details. It's useful for debugging and understanding the environment in which the LinkJS application is running.

```javascript
[202601-0915H02:56
VARVI,OVERLAY,VO;
//文字叠加
T2026-0109
PROJECTJSON
[2026-01-0915:0
HELLOWORLD
口IMG
口CONFIG
HELLOWORLD
ADMIN
/视频输入
系统日志
1080
20元1080P60G0
[2026-01-09
15:02:56.711]PROIECT:"HELLOWORLD"VERSION;"1.0.0"
56.4571TINKSDK4.4.0BUI1D2025122330769
```

--------------------------------

### Importing Modules in JavaScript

Source: https://www.yuque.com/linkpi/linkjs/qepefluf1x23t9ci

This snippet demonstrates how to import modules in JavaScript, specifically for a project structure that includes a 'menu.js' file. It's a common pattern for organizing code into reusable components.

```javascript
MPORTINITMENUFROMMENU.JS
FUNCTIONMAINL
MAIN.JIS
```

--------------------------------

### LCD Library API

Source: https://www.yuque.com/linkpi/linkjs/booqqnfauutuc54g

Core functions for interacting with the LCD/OLED screen, including setting HTML content, managing pages, and updating data.

```APIDOC
## LCD Library API

### Description
Provides methods to control the device's onboard screen, supporting custom HTML content and multi-page interactive menus.

### Methods

#### `LCD.setHtml(html)`

##### Description
Displays custom HTML content on the screen.

##### Method
`setHtml`

##### Parameters

*   **html** (string) - Required - HTML code or text to display.

##### Return Value
None

#### `LCD.addPage(path, jsObj)`

##### Description
Adds an operation page, enabling multi-page interactive menus. Refer to `script/menu.js` in the LCD project for detailed usage.

##### Method
`addPage`

##### Parameters

*   **path** (string) - Required - Path to the HTML template file.
*   **jsObj** (object) - Required - Object containing page function definitions. Similar to Vue's parameter structure.

##### Return Value
None

#### `LCD.gotoPage(index)`

##### Description
Navigates to a specified page and refreshes its content. Refer to `script/menu.js` in the LCD project for detailed usage.

##### Method
`gotoPage`

##### Parameters

*   **index** (number) - Required - The page number, starting from 0.

##### Return Value
None

#### `LCD.setData(data)`

##### Description
Sets data for the current page. Fields in the HTML template should correspond to the keys in this data object. Refer to `lcd_pages/*.js` for usage examples.

##### Method
`setData`

##### Parameters

*   **data** (object) - Required - Data object to populate the current page's template.

##### Return Value
None
```

--------------------------------

### LED Mode and Color Control

Source: https://www.yuque.com/linkpi/linkjs/nvyooc2twye0a2tp_language=zh-cn

This endpoint allows you to set the LED animation mode and the target color (RGB).

```APIDOC
## SET /led/mode

### Description
Sets the LED animation mode and target color.

### Method
POST

### Endpoint
/led/mode

### Parameters
#### Request Body
- **mode** (string) - Required - The animation type. Possible values: "cut" (hard cut), "breathe" (breathing effect), "flick" (flickering effect), "slide" (slide-in effect).
- **R** (integer) - Required - Red color component, value between 0 and 255.
- **G** (integer) - Required - Green color component, value between 0 and 255.
- **B** (integer) - Required - Blue color component, value between 0 and 255.

### Request Example
```json
{
  "mode": "breathe",
  "R": 255,
  "G": 0,
  "B": 0
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Create Input Video Interface in LinkJS

Source: https://www.yuque.com/linkpi/linkjs/aq1o6glahhbwftoa_language=en-us

This snippet shows how to create an input video interface using LinkJS. It defines a variable 'VI' and assigns it a new input video interface.

```LinkJS
VIELINK.CREATE"INPUTVI"):
```

--------------------------------

### LCD Core Library API

Source: https://www.yuque.com/linkpi/linkjs/booqqnfauutuc54g_language=en-us

This section details the core functions available in the LCD library for displaying content, managing pages, and setting data.

```APIDOC
## LCD Core Library API

### Description
This library provides functions to control the device's onboard small screen display and key interactions. It encapsulates the built-in LCD interface and utilizes the GPIO module from LinkSDK. While `setHtml` is the primary interface, it supports a simplified richtext module for rendering, so it's recommended to design using the core library's CSS styles.

The library automatically detects screen type (LCD: 240x135, 16-bit color; OLED: 128x64, monochrome) and applies appropriate CSS styles.

### Methods

#### `LCD.setHtml(html)`

##### Description
Displays custom HTML content on the screen.

##### Method
`POST`

##### Endpoint
`/lcd/setHtml`

##### Parameters

###### Request Body
- **html** (string) - Required - The HTML code or text to display.

##### Request Example
```json
{
  "html": "<h1>Hello World!</h1><p>This is custom content.</p>"
}
```

##### Response

###### Success Response (200)
- **status** (string) - Indicates the success of the operation.

###### Response Example
```json
{
  "status": "success"
}
```

#### `LCD.addPage(path, jsObj)`

##### Description
Adds an operation page, allowing for multi-page interactive menus.

##### Method
`POST`

##### Endpoint
`/lcd/addPage`

##### Parameters

###### Request Body
- **path** (string) - Required - The path to the HTML template file for the page.
- **jsObj** (object) - Required - An object defining the page's functions. Its parameters correspond to fields in the HTML template, similar to Vue.js.

##### Request Example
```json
{
  "path": "/templates/menuPage.html",
  "jsObj": {
    "onEnter": "function() { console.log('Entering menu page'); }",
    "onExit": "function() { console.log('Exiting menu page'); }"
  }
}
```

##### Response

###### Success Response (200)
- **status** (string) - Indicates the success of the operation.

###### Response Example
```json
{
  "status": "success"
}
```

#### `LCD.gotoPage(index)`

##### Description
Navigates to and refreshes a specified page.

##### Method
`POST`

##### Endpoint
`/lcd/gotoPage`

##### Parameters

###### Request Body
- **index** (integer) - Required - The zero-based index of the page to navigate to.

##### Request Example
```json
{
  "index": 1
}
```

##### Response

###### Success Response (200)
- **status** (string) - Indicates the success of the operation.

###### Response Example
```json
{
  "status": "success"
}
```

#### `LCD.setData(data)`

##### Description
Sets data for the current page, which can be used in the HTML template.

##### Method
`POST`

##### Endpoint
`/lcd/setData`

##### Parameters

###### Request Body
- **data** (object) - Required - A data object whose fields correspond to fields in the HTML template.

##### Request Example
```json
{
  "data": {
    "title": "Welcome",
    "value": 100
  }
}
```

##### Response

###### Success Response (200)
- **status** (string) - Indicates the success of the operation.

###### Response Example
```json
{
  "status": "success"
}
```

### Screen Types

- **LCD Screen**: ENC1V3 (sold after June 2025), ENC1V3P, UVC2, ENCS1Pro. Resolution: 240x135, 16-bit color.
- **OLED Screen**: Other models, including ENC1V3 sold before June 2025. Resolution: 128x64, monochrome.

The LCD library automatically detects the screen type and switches CSS styles for adaptation.
```

--------------------------------

### Set LED Animation and Color using LinkJS

Source: https://www.yuque.com/linkpi/linkjs/nvyooc2twye0a2tp

Configures LED animations and their target colors. Supports different animation modes like 'cut', 'breathe', 'flick', and 'slide', along with RGB color values.

```javascript
led.setLED(mode, R, G, B)
// mode：动画类型，可选值 cut-硬切，breathe-呼吸，flick-闪烁，slide-划入
// RGB: 红绿蓝，取值范围[0,255]
```

--------------------------------

### Manage Multi-Page Menus with LinkJS LCD Library

Source: https://www.yuque.com/linkpi/linkjs/booqqnfauutuc54g_language=zh-cn

The LinkJS LCD library allows for the creation of multi-page interactive menus. The `addPage` method registers a new page with its corresponding HTML template path and JavaScript object defining its functions. Subsequently, `gotoPage` allows navigation between these registered pages.

```javascript
LCD.addPage(path, jsObj);
// path: Path to the HTML template file.
// jsObj: Object containing page function definitions.
// Returns: void

LCD.gotoPage(index);
// index: The page number, starting from 0.
// Returns: void
```

--------------------------------

### Link.connectEvent(object, callback)

Source: https://www.yuque.com/linkpi/linkjs/wg8xz6zswrnkudol

Connects a module's event signals to a JavaScript callback function. This allows your application to receive real-time updates and information from the LinkSDK modules.

```APIDOC
## POST Link.connectEvent(object, callback)

### Description
Connects a module's event signals to a JavaScript callback function. This allows your application to receive real-time updates and information from the LinkSDK modules.

### Method
POST

### Endpoint
/link/connectEvent

### Parameters
#### Request Body
- **object** (object) - Required - The LinkObject instance created by `Link.create()`.
- **callback** (function) - Required - The JavaScript callback function to handle events. It will receive `type` (event type) and `info` (event information) as arguments.

### Request Example
```javascript
Link.connectEvent(myModuleObject, function(type, info) {
  console.log('Event received:', type, info);
});
```

### Response
#### Success Response (200)
- **message** (string) - Indicates successful connection.

#### Response Example
```json
{
  "result": "Event connection successful."
}
```
```

--------------------------------

### LED Brightness Control

Source: https://www.yuque.com/linkpi/linkjs/nvyooc2twye0a2tp_language=zh-cn

This endpoint allows you to set the brightness of the LED lights. The brightness is controlled by a float value between 0 and 1.

```APIDOC
## SET /led/brightness

### Description
Sets the brightness of the LED lights.

### Method
POST

### Endpoint
/led/brightness

### Parameters
#### Request Body
- **value** (float) - Required - The desired brightness level, a float value between 0.0 and 1.0.

### Request Example
```json
{
  "value": 0.75
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Display HTML Content with LinkJS LCD Library

Source: https://www.yuque.com/linkpi/linkjs/booqqnfauutuc54g_language=zh-cn

The `setHtml` method displays custom HTML content on the LCD screen. It accepts an HTML string or text as input. This method is a core function for rendering dynamic content, but it has limitations regarding full HTML and CSS support, relying on a simplified richtext module for rendering.

```javascript
LCD.setHtml(html);
// html: The HTML code or text to display.
// Returns: void
```

--------------------------------

### Link.connectEvent(object, callback)

Source: https://www.yuque.com/linkpi/linkjs/wg8xz6zswrnkudol_language=zh-cn

Connects the event signals of a module object to a JavaScript callback function. This allows your application to receive event notifications from the module.

```APIDOC
## POST /link/connectEvent

### Description
Connects the event signals of a created module object to a JavaScript callback function. The callback function will be invoked when events occur.

### Method
POST

### Endpoint
/link/connectEvent

### Parameters
#### Request Body
- **object** (object) - Required - The module object created using `Link.create()`.
- **callback** (function) - Required - The JavaScript callback function to handle events. It should accept `type` (event type) and `info` (event information) as arguments. Example: `function onEvent(type, info) { ... }`

### Request Example
```json
{
  "object": {"__internal_id": "some_id"}, 
  "callback": "function onEvent(type, info) { console.log(type, info); }"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation. (No specific return value detailed, implies void or status confirmation).

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### LED Animation and Color Control

Source: https://www.yuque.com/linkpi/linkjs/nvyooc2twye0a2tp_language=en-us

Sets the animation mode and target color for the LED strip lights. Supports various animation types and RGB color values.

```APIDOC
## led.setLED(mode, R, G, B)

### Description
Sets the LED animation mode and target color. You can choose from different animation types and specify the RGB color values.

### Method
N/A (Function call within LinkJS)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **mode** (string) - Required - The animation type. Options: "cut" (hard cut), "breathe" (breathing effect), "flick" (flickering effect), "slide" (slide-in effect).
- **R** (integer) - Required - The Red color component, an integer value between 0 and 255.
- **G** (integer) - Required - The Green color component, an integer value between 0 and 255.
- **B** (integer) - Required - The Blue color component, an integer value between 0 and 255.

### Request Example
```javascript
// Example of setting a breathing red light
led.setLED("breathe", 255, 0, 0);

// Example of setting a slide-in effect with blue color
led.setLED("slide", 0, 0, 255);
```

### Response
#### Success Response (200)
N/A (Function call within LinkJS)

#### Response Example
N/A
```

--------------------------------

### LED Brightness Control

Source: https://www.yuque.com/linkpi/linkjs/nvyooc2twye0a2tp_language=en-us

Sets the brightness of the LED strip lights. The brightness can be adjusted to a value between 0 and 1.

```APIDOC
## led.setBrightness(value)

### Description
Sets the brightness of the LED strip lights.

### Method
N/A (Function call within LinkJS)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **value** (float) - Required - The desired brightness level, a float value between 0 and 1.

### Request Example
```javascript
// Example of setting brightness to 0.8
led.setBrightness(0.8);
```

### Response
#### Success Response (200)
N/A (Function call within LinkJS)

#### Response Example
N/A
```

--------------------------------

### Set LED Brightness using LinkJS

Source: https://www.yuque.com/linkpi/linkjs/nvyooc2twye0a2tp

Sets the brightness of the LED indicator lights. The value is a floating-point number between 0 (off) and 1 (full brightness).

```javascript
led.setBrightness(value)
// value: 浮点型，[0,1]
```

--------------------------------

### Set Data for Current Page in LinkJS LCD Library

Source: https://www.yuque.com/linkpi/linkjs/booqqnfauutuc54g_language=zh-cn

The `setData` method is used to update the data displayed on the current page of the LCD. It accepts a data object where field names correspond to placeholders in the HTML template file. This enables dynamic updates of displayed information.

```javascript
LCD.setData(data);
// data: Data object mapping to fields in the HTML template.
// Returns: void
```

--------------------------------

### Connect Module Event Signals with Link.connectEvent()

Source: https://www.yuque.com/linkpi/linkjs/wg8xz6zswrnkudol_language=en-us

Connects event signals from a LinkSDK module object to a JavaScript callback function. The callback function receives the event type and associated information. This is essential for handling asynchronous events triggered by the module. Does not return a value.

```javascript
Link.connectEvent(object, callback)
```
Tokens:
Raw