@deviots/ 电容- tcp客户端

拥有本土Android,iOS和Electron支持的Capacitorapp的TCP客户端插件.

当您的应用程序需要直接与 TCP 设备或服务交谈时使用它, 例如 打印机,扫描仪,控制器,网关或本地网络硬件.

特征

• Android、iOS和Electron上的原生TCP套接字
• 多连接 API 与每个连接的孤立听众
• 原始写作、连续流读取和请求/答复读取
• 字节有效载荷为 number[] 或者说 Uint8Array
• 可选 expect 协议回复的匹配模式
• 用于浏览器开发的 Web stub 构建

安装

npm install @devioarts/capacitor-tcpclient
npx cap sync

Android网络权限从插件列表中自动合并. 见 开始 手动Android回落笔记 和所需的iOS设置.

快速启动

import { TCPClient } from '@devioarts/capacitor-tcpclient';

const conn = TCPClient.createConnection({
  host: '192.168.1.100',
  port: 9100,
  timeout: 3000,
});

await conn.connect();

const reply = await conn.writeAndRead({
  data: [0x1b, 0x40],
  timeout: 1000,
  maxBytes: 4096,
});

if (reply.error) {
  console.error(reply.errorMessage);
} else {
  console.log('Received bytes:', reply.data);
}

await conn.destroy();

控制器 App 示例

import { TCPClient, type TCPConnection } from '@devioarts/capacitor-tcpclient';

let connection: TCPConnection | undefined;

export async function connectToDevice(host: string) {
  connection = TCPClient.createConnection({ connectionId: 'main-device', host, port: 9100 });

  await connection.addListener('tcpDisconnect', ({ reason, error }) => {
    console.log('TCP disconnected:', reason, error ?? '');
  });

  return connection.connect();
}

export async function sendCommand(command: Uint8Array) {
  if (!connection) throw new Error('TCP connection is not ready');

  return connection.writeAndRead({
    data: command,
    expect: '0d0a',
    timeout: 1500,
    maxBytes: 8192,
  });
}

export async function disconnectFromDevice() {
  await connection?.destroy();
  connection = undefined;
}

文档

• 开始:安装、Android/iOS设置和操场笔记
• 使用指南:电容实例、流出、请求/响应和生命周期模式
• 电能融合:电源和手动电桥设置
• 行为和问题: 超时、缓冲、平台注释和故障排除
• API 参考: 在此 README 中生成 TypeScript API 引用

平台支持

常见命令

npm run build
npm test
npm run verify:web

API 密码

下面生成的 API 文档根 @devioarts/capacitor-tcpclient capacitor apps使用的出入口. 手册 电桥直接在IPC上暴露出当地的方法,所以它使用 connectionId 每一次电话,而不是 createConnection()。 。 。 .

• createConnection(...)
• getPluginPlatform()
• 接口
• 类型异名

创建连接(...)

createConnection(options?: TcpCreateConnectionOptions | undefined) => TCPConnection

创建( 或检索) TCP 连接实例 .

• 没有连接Id:总是用生成的UUID创建新实例.
• 连接Id: 如果已创建, 返回已有实例 , 否则就会产生新的问题.
• 这里提供的主机/端口/出站/无Delay/keepAlive成为连接的默认值 ().

回返情况: TCPConnection

获取 Plugin 公式 ()

getPluginPlatform() => Promise<TcpGetPlatformResult>

返回此插件本地执行的平台标识符 ("ios""android""electron""网站").

与电容核心的区别 Capacitor.getPlatform() ——当 你需要知道TCP层是否有iOS,Android,Electron的支持, 或浏览器开发根.

回返情况: Promise<TcpGetPlatformResult>

接口

技术合作中心

由 TCPClient.createConnection () 返回的单个 TCP 连接实例 . 每个实例都有自己的插座、事件听众和生命周期.

TcpConnect 结果

Tcp 连接选项

Tcp 断开连接结果

TcpIsConnected 成果

TcpIs 读取结果

TcpWrite 结果

TcpWrite 选项

TcpByte 箭头类似

类似字节的数组被写入 API 所接受. 支持Uint8Array是因为它有数值索引和长度.

TcpWriteAndRead Result (英语)

TcpWrite 读取选项

TcpStart 停止执行

Tcp 开始读取选项

插件听筒

TcpData 事件

被溪读取者所入. 连接ID 识别哪个连接发送数据 .

Tcp 断开事件

连接关闭时发出通知 .

Tcp 创建连接选项

TCPClient.createConnection () 的选项. 所有字段都是可选的. 这里设置的主机/ 端口和其他连接选项变为 在返回实例上调用每个连接的默认值 .

TcpGetPlatform 结果

类型异名

部分

让 T 中的所有属性可选

{ [P in keyof T]?: T[P]; }

TcpBytePay 负荷

被写入 API 接受的字节有效载荷 。 值必须是0.255范围内的整数字节.

number[] | TcpByteArrayLike

Tcp 公式

'ios' | 'android' | 'web' | 'electron'

许可证

麻省理工学院