This shows you the differences between two versions of the page.
Both sides previous revision Previous revision | Last revision Both sides next revision | ||
component:modem:zh [2023/10/25 09:32] hfsr [Component: Modem] |
component:modem:zh [2023/12/27 03:08] hfsr [组件:调制解调器] |
||
---|---|---|---|
Line 8: | Line 8: | ||
- `isWireless(): boolean` | - `isWireless(): boolean` | ||
- | 返回此调制解调器是否可用于发送无线信息。 | + | 返回此调制解调器是否可用于发送无线信息。 |
+ | \\ | ||
- `maxPacketSize(): number` | - `maxPacketSize(): number` | ||
返回通过网卡传输信息时的最大数据包大小,默认为8192。你可以在OC模组的配置文件中修改此数值。 | 返回通过网卡传输信息时的最大数据包大小,默认为8192。你可以在OC模组的配置文件中修改此数值。 | ||
Line 15: | Line 16: | ||
样例: | 样例: | ||
* `"foo"`是一个5字节长的数据包;开头添加2字节,内容有3字节长的字符串。 | * `"foo"`是一个5字节长的数据包;开头添加2字节,内容有3字节长的字符串。 | ||
- | * `"currentStatus",300`是一个25字节长的数据包;开头添加4字节,内容有13字节长的字符串和一个占8字节的数字。 | + | * `"currentStatus",300`是一个25字节长的数据包;开头添加4字节,内容有13字节长的字符串和一个占8字节的数字。 |
+ | \\ | ||
- `isOpen(port: number): boolean` | - `isOpen(port: number): boolean` | ||
- | 返回指定“端口”是否处于侦听状态。信息只有在传输到开放的端口时才会触发信号。 | + | 返回指定“端口”是否处于侦听状态。信息只有在传输到开放的端口时才会触发信号。 |
+ | \\ | ||
- `open(port: number): boolean` | - `open(port: number): boolean` | ||
- | 开放指定编号的端口,使其开始侦听。开启成功则返回`true`,若已开启则返回`false`。**注: 最大端口号为65535** | + | 开放指定编号的端口,使其开始侦听。开启成功则返回`true`,若已开启则返回`false`。**注: 最大端口号为65535** |
+ | \\ | ||
- `close([port: number]): boolean` | - `close([port: number]): boolean` | ||
- | 关闭指定端口(不指定则默认为全部端口)。若端口成功关闭则返回`true`。 | + | 关闭指定端口(不指定则默认为全部端口)。若端口成功关闭则返回`true`。 |
+ | \\ | ||
- `send(address: string, port: number[, ...]): boolean` | - `send(address: string, port: number[, ...]): boolean` | ||
- | 向指定地址发送一条网络信息。若信息发送成功返回 `true` ,但**不意味着**信息已被接收,只意味着已被发送。我们不提供端口嗅探功能。 | + | 向指定地址发送一条网络信息。若信息发送成功返回 `true` ,但**不意味着**信息已被接收,只意味着已被发送。我们不提供端口嗅探功能。 |
- | 传递给此函数的所有额外参数都将被作为数据传输。这些参数必须是基本类型:支持`nil`、布尔型、数字型以及字符串型,而不支持表和函数。参阅[[api:serialization:zh|serialization(串连) API]]以获取将表序列化的方法。 | + | 传递给此函数的所有额外参数都将被作为数据传输。这些参数必须是基本类型:支持`nil`、布尔型、数字型以及字符串型,而不支持表和函数。参阅[[api:serialization:zh|serialization(序列化) API]]以获取将表序列化的方法。 |
- | 额外参数的数量有上限,默认限制为8。此限制可以在OC模组的配置文件中修改,但是**不推荐**这样做。将限制调高可能会使性能较弱的电脑不可避免地经常崩溃,而将限制调低可能会使某些协议无法工作。 | + | 额外参数的数量有上限,默认限制为8。此限制可以在OC模组的配置文件中修改,但是**不推荐**这样做。将限制调高可能会使性能较弱的电脑不可避免地经常崩溃,而将限制调低可能会使某些协议无法工作。 |
+ | \\ | ||
- `broadcast(port: number, ...): boolean` | - `broadcast(port: number, ...): boolean` | ||
- | 发送一条广播信息。此信息会被发送给所有可到达的网卡。若信息被成功发送则返回 `true`。请注意广播信息**不会**传递给发送这条信息的调制解调器自身。 | + | 发送一条广播信息。此信息会被发送给所有可到达的网卡。若信息被成功发送则返回 `true`。请注意广播信息**不会**传递给发送这条信息的调制解调器自身。 |
- | 所有额外参数都将作为数据一并发送,参见`send`。 | + | 所有额外参数都将作为数据一并发送,参见`send`。 |
+ | \\ | ||
- `getStrength(): number` | - `getStrength(): number` | ||
获取当前发送信息时使用的信号强度。 | 获取当前发送信息时使用的信号强度。 | ||
- | //仅限无线网卡。// | + | **仅限无线网卡。** |
+ | \\ | ||
- `setStrength(value: number): number` | - `setStrength(value: number): number` | ||
设置信号强度。若此值被设定为大于0,则发送信息时会同时生成一条无线信息。若调用此函数时设定的强度超出调制解调器的最大信号强度,则会将其信号强度设定为允许的最大值。信号强度越高,发送信息时所需的能量就越多。 | 设置信号强度。若此值被设定为大于0,则发送信息时会同时生成一条无线信息。若调用此函数时设定的强度超出调制解调器的最大信号强度,则会将其信号强度设定为允许的最大值。信号强度越高,发送信息时所需的能量就越多。 | ||
- | //仅限无线网卡。// | + | **仅限无线网卡。** |
+ | \\ | ||
- `getWakeMessage():string` | - `getWakeMessage():string` | ||
- | 获取当前设置的唤醒信息。当网卡的任意端口检测到了唤醒信息(某网络数据包第一个参数中的字符串),而电脑处于关闭状态,则电脑会启动。可用于机器人、普通电脑、服务器、无人机以及平板电脑。[[component:tunnel:zh|连接卡]]也提供了相同的功能。 | + | 获取当前设置的唤醒信息。当网卡的任意端口检测到了唤醒信息(某网络数据包第一个参数中的字符串),而电脑处于关闭状态,则电脑会启动。可用于机器人、普通电脑、服务器、无人机以及平板电脑。[[component:tunnel:zh|连接卡]]也提供了相同的功能。 |
+ | \\ | ||
- `setWakeMessage(message: string, [fuzzy: boolean]):string` | - `setWakeMessage(message: string, [fuzzy: boolean]):string` | ||
将唤醒信息设定为给定的**字符串**。信息可以模糊匹配(由`fuzzy`参数决定,默认为`false`)。模糊匹配时会忽略网络数据包中的其他参数。 | 将唤醒信息设定为给定的**字符串**。信息可以模糊匹配(由`fuzzy`参数决定,默认为`false`)。模糊匹配时会忽略网络数据包中的其他参数。 |