EthernetService¶
Method | LwM2M request | Description |
---|---|---|
getIp | get /1024//85 alias: /ethernet/ip |
Get Ethernet IP |
putIp | put /1024//85 alias: /ethernet/ip |
Set ethernet IP address |
getGatewayIp | get /1024//86 alias: /ethernet/gateway-ip |
Get gateway IP address |
putGatewayIp | put /1024//86 alias: /ethernet/gateway-ip |
Write gateway IP address |
getIpMask | get /1024//87 alias: /ethernet/ip-mask |
Get ethernet gateway IP mask |
putIpMask | put /1024//87 alias: /ethernet/ip-mask |
Write ethernet gateway IP mask |
getHostname | get /1024//93 alias: /ethernet/hostname |
Get ethernet hostname |
getDnsIp | get /1024//124 alias: /ethernet/dns-ip |
Get ethernet network dns ip |
putDnsIp | put /1024//124 alias: /ethernet/dns-ip |
Write ethernet network dns ip |
getEnabled | get /1024//130 alias: /ethernet/enabled |
Get Ethernet enable status |
putEnabled | put /1024//130 alias: /ethernet/enabled |
Write Ethernet enable status |
getIp¶
Minimal Tap Firmware version: 2.7
Get Ethernet IP
Parameters¶
This endpoint does not need any parameter.
Returns¶
string (ipv4)
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const response = await tap.service.ethernet.getIp();
const value = response.body();
console.log(`getIp: ${value}`);
putIp¶
Minimal Tap Firmware version: 2.7
Set ethernet IP address
Parameters¶
Name | Type | Description | Notes |
---|---|---|---|
data | string | optional |
Returns¶
Nothing
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const data = ...;
const response = await tap.service.ethernet.putIp(data);
const value = response.body();
console.log(`putIp: ${value}`);
getGatewayIp¶
Minimal Tap Firmware version: 2.7
Get gateway IP address
Parameters¶
This endpoint does not need any parameter.
Returns¶
string (ipv4)
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const response = await tap.service.ethernet.getGatewayIp();
const value = response.body();
console.log(`getGatewayIp: ${value}`);
putGatewayIp¶
Minimal Tap Firmware version: 2.7
Write gateway IP address
Parameters¶
Name | Type | Description | Notes |
---|---|---|---|
data | string | optional |
Returns¶
Nothing
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const data = ...;
const response = await tap.service.ethernet.putGatewayIp(data);
const value = response.body();
console.log(`putGatewayIp: ${value}`);
getIpMask¶
Minimal Tap Firmware version: 2.7
Get ethernet gateway IP mask
Parameters¶
This endpoint does not need any parameter.
Returns¶
string (ipv4mask)
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const response = await tap.service.ethernet.getIpMask();
const value = response.body();
console.log(`getIpMask: ${value}`);
putIpMask¶
Minimal Tap Firmware version: 2.7
Write ethernet gateway IP mask
Parameters¶
Name | Type | Description | Notes |
---|---|---|---|
data | string | optional |
Returns¶
Nothing
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const data = ...;
const response = await tap.service.ethernet.putIpMask(data);
const value = response.body();
console.log(`putIpMask: ${value}`);
getHostname¶
Minimal Tap Firmware version: 2.7
Get ethernet hostname
Parameters¶
This endpoint does not need any parameter.
Returns¶
string
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const response = await tap.service.ethernet.getHostname();
const value = response.body();
console.log(`getHostname: ${value}`);
getDnsIp¶
Minimal Tap Firmware version: 2.7
Get ethernet network dns ip
Parameters¶
This endpoint does not need any parameter.
Returns¶
string (ipv4)
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const response = await tap.service.ethernet.getDnsIp();
const value = response.body();
console.log(`getDnsIp: ${value}`);
putDnsIp¶
Minimal Tap Firmware version: 2.7
Write ethernet network dns ip
Parameters¶
Name | Type | Description | Notes |
---|---|---|---|
key | string | optional |
Returns¶
Nothing
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const key = ...;
const response = await tap.service.ethernet.putDnsIp(key);
const value = response.body();
console.log(`putDnsIp: ${value}`);
getEnabled¶
Minimal Tap Firmware version: 2.7
Get Ethernet enable status
Parameters¶
This endpoint does not need any parameter.
Returns¶
boolean
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const response = await tap.service.ethernet.getEnabled();
const value = response.body();
console.log(`getEnabled: ${value}`);
putEnabled¶
Minimal Tap Firmware version: 2.7
Write Ethernet enable status
Parameters¶
Name | Type | Description | Notes |
---|---|---|---|
isEnabled | boolean | optional |
Returns¶
Nothing
Example¶
import { Tap } from "@iotize/tap";
const tap: Tap = ...;
const isEnabled = ...;
const response = await tap.service.ethernet.putEnabled(isEnabled);
const value = response.body();
console.log(`putEnabled: ${value}`);