WifiService¶

Method	LwM2M request	Description
getMode	get /1024//15 alias: /wifi/mode	Get Wi-Fi mode
putMode	put /1024//15 alias: /wifi/mode	Write Wi-Fi mode
getKey	get /1024//16 alias: /wifi/key	Get Wi-Fi key
putKey	put /1024//16 alias: /wifi/key	Write network key
getHostname	get /1024//35 alias: /wifi/hostname	Get Wi-Fi hostname
getIp	get /1024//30 alias: /wifi/ip	Get IoTize device ip on the network
putIp	put /1024//30 alias: /wifi/ip	Write Tap IP
getGatewayIp	get /1024//31 alias: /wifi/gateway-ip	Get gateway ip on the network
putGatewayIp	put /1024//31 alias: /wifi/gateway-ip	Write gateway ip
getIpMask	get /1024//32 alias: /wifi/ip-mask	Get network ip mask
putIpMask	put /1024//32 alias: /wifi/ip-mask	Write network ip mask
getDnsIp	get /1024//124 alias: /wifi/dns-ip	Get network dns ip
putDnsIp	put /1024//124 alias: /wifi/dns-ip	Write network dns ip
getSSID	get /1024//25 alias: /wifi/ssid	Get Wi-Fi ssid
putSSID	put /1024//25 alias: /wifi/ssid	Write Wi-Fi ssid
getCountryCode	get /1024//95 alias: /wifi/country-code	Get Wi-Fi country code
putCountryCode	put /1024//95 alias: /wifi/country-code	Write Wi-Fi country code
getProtocol	get /1024//96 alias: /wifi/protocol	Get Wi-Fi protocol
putProtocol	put /1024//96 alias: /wifi/protocol	Write Wi-Fi protocol
getTxPower	get /1024//97 alias: /wifi/tx-power	Get Wi-Fi TX max power
putTxPower	put /1024//97 alias: /wifi/tx-power	Write Wi-Fi TX max power
getSSIDVisibility	get /1024//98 alias: /wifi/ssid-visibility	Get Wi-Fi SSID visibility
putSSIDVisibility	put /1024//98 alias: /wifi/ssid-visibility	Write Wi-Fi SSID visibility
getKeyVisibility	get /1024//99 alias: /wifi/key-visibility	Get Wi-Fi key visibility
putKeyVisibility	put /1024//99 alias: /wifi/key-visibility	Write Wi-Fi key visibility
getNetworkMode	get /1024//128 alias: /wifi/network-mode	Get Wi-Fi network mode
putNetworkMode	put /1024//128 alias: /wifi/network-mode	Write Wi-Fi network mode
getDisabled	get /1024//129 alias: /wifi/disabled	Get Wi-Fi disable status
putDisabled	put /1024//129 alias: /wifi/disabled	Write Wi-Fi disable status

getMode¶

Get Wi-Fi mode

Parameters¶

This endpoint does not need any parameter.

Returns¶

WifiMode

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.wifi.getMode();
const value = response.body();
console.log(`getMode: ${value}`);

putMode¶

Write Wi-Fi mode

Parameters¶

Name	Type	Description	Notes
mode	WifiMode		optional

Returns¶

Nothing

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const mode = ...;
const response = await tap.service.wifi.putMode(mode);
const value = response.body();
console.log(`putMode: ${value}`);

getKey¶

Get Wi-Fi key

Parameters¶

This endpoint does not need any parameter.

Returns¶

string

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.wifi.getKey();
const value = response.body();
console.log(`getKey: ${value}`);

putKey¶

Write network key

Parameters¶

Name	Type	Description	Notes
key	string		optional

Returns¶

Nothing

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const key = ...;
const response = await tap.service.wifi.putKey(key);
const value = response.body();
console.log(`putKey: ${value}`);

getHostname¶

Get Wi-Fi hostname

Parameters¶

This endpoint does not need any parameter.

Returns¶

string

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.wifi.getHostname();
const value = response.body();
console.log(`getHostname: ${value}`);

getIp¶

Get IoTize device ip on the network

Parameters¶

This endpoint does not need any parameter.

Returns¶

string (ipv4)

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.wifi.getIp();
const value = response.body();
console.log(`getIp: ${value}`);

putIp¶

Write Tap IP

Parameters¶

Name	Type	Description	Notes
key	string		optional

Returns¶

Nothing

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const key = ...;
const response = await tap.service.wifi.putIp(key);
const value = response.body();
console.log(`putIp: ${value}`);

getGatewayIp¶

Get gateway ip on the network

Parameters¶

This endpoint does not need any parameter.

Returns¶

string (ipv4)

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.wifi.getGatewayIp();
const value = response.body();
console.log(`getGatewayIp: ${value}`);

putGatewayIp¶

Write gateway ip

Parameters¶

Name	Type	Description	Notes
key	string		optional

Returns¶

Nothing

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const key = ...;
const response = await tap.service.wifi.putGatewayIp(key);
const value = response.body();
console.log(`putGatewayIp: ${value}`);

getIpMask¶

Get network ip mask

Parameters¶

This endpoint does not need any parameter.

Returns¶

string (ipv4mask)

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.wifi.getIpMask();
const value = response.body();
console.log(`getIpMask: ${value}`);

putIpMask¶

Write network ip mask

Parameters¶

Name	Type	Description	Notes
key	string		optional

Returns¶

Nothing

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const key = ...;
const response = await tap.service.wifi.putIpMask(key);
const value = response.body();
console.log(`putIpMask: ${value}`);

getDnsIp¶

Get network dns ip

Parameters¶

This endpoint does not need any parameter.

Returns¶

string (ipv4)

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.wifi.getDnsIp();
const value = response.body();
console.log(`getDnsIp: ${value}`);

putDnsIp¶

Write network dns ip

Parameters¶

Name	Type	Description	Notes
key	string		optional

Returns¶

Nothing

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const key = ...;
const response = await tap.service.wifi.putDnsIp(key);
const value = response.body();
console.log(`putDnsIp: ${value}`);

getSSID¶

Get Wi-Fi ssid

Parameters¶

This endpoint does not need any parameter.

Returns¶

string

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.wifi.getSSID();
const value = response.body();
console.log(`getSSID: ${value}`);

putSSID¶

Write Wi-Fi ssid

Parameters¶

Name	Type	Description	Notes
key	string		optional

Returns¶

Nothing

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const key = ...;
const response = await tap.service.wifi.putSSID(key);
const value = response.body();
console.log(`putSSID: ${value}`);

getCountryCode¶

Get Wi-Fi country code

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint16)

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.wifi.getCountryCode();
const value = response.body();
console.log(`getCountryCode: ${value}`);

putCountryCode¶

Write Wi-Fi country code

Parameters¶

Name	Type	Description	Notes
countryCode	number	ISO 3166 codes	optional

Returns¶

Nothing

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const countryCode = ...;
const response = await tap.service.wifi.putCountryCode(countryCode);
const value = response.body();
console.log(`putCountryCode: ${value}`);

getProtocol¶

Get Wi-Fi protocol

Parameters¶

This endpoint does not need any parameter.

Returns¶

WifiProtocol

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.wifi.getProtocol();
const value = response.body();
console.log(`getProtocol: ${value}`);

putProtocol¶

Write Wi-Fi protocol

Parameters¶

Name	Type	Description	Notes
protocol	WifiProtocol[]		optional

Returns¶

Nothing

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const protocol = ...;
const response = await tap.service.wifi.putProtocol(protocol);
const value = response.body();
console.log(`putProtocol: ${value}`);

getTxPower¶

Get Wi-Fi TX max power

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (int8)

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.wifi.getTxPower();
const value = response.body();
console.log(`getTxPower: ${value}`);

putTxPower¶

Write Wi-Fi TX max power

Parameters¶

Name	Type	Description	Notes
maxPower	number		optional

Returns¶

Nothing

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const maxPower = ...;
const response = await tap.service.wifi.putTxPower(maxPower);
const value = response.body();
console.log(`putTxPower: ${value}`);

getSSIDVisibility¶

Get Wi-Fi SSID visibility

Parameters¶

This endpoint does not need any parameter.

Returns¶

WifiSSIDVisibility

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.wifi.getSSIDVisibility();
const value = response.body();
console.log(`getSSIDVisibility: ${value}`);

putSSIDVisibility¶

Write Wi-Fi SSID visibility

Parameters¶

Name	Type	Description	Notes
visibility	WifiSSIDVisibility		optional

Returns¶

Nothing

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const visibility = ...;
const response = await tap.service.wifi.putSSIDVisibility(visibility);
const value = response.body();
console.log(`putSSIDVisibility: ${value}`);

getKeyVisibility¶

Get Wi-Fi key visibility

Parameters¶

This endpoint does not need any parameter.

Returns¶

WifiKeyVisibility

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.wifi.getKeyVisibility();
const value = response.body();
console.log(`getKeyVisibility: ${value}`);

putKeyVisibility¶

Write Wi-Fi key visibility

Parameters¶

Name	Type	Description	Notes
visibility	WifiKeyVisibility		optional

Returns¶

Nothing

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const visibility = ...;
const response = await tap.service.wifi.putKeyVisibility(visibility);
const value = response.body();
console.log(`putKeyVisibility: ${value}`);

getNetworkMode¶

Get Wi-Fi network mode

Parameters¶

This endpoint does not need any parameter.

Returns¶

WifiMode

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.wifi.getNetworkMode();
const value = response.body();
console.log(`getNetworkMode: ${value}`);

putNetworkMode¶

Write Wi-Fi network mode

Parameters¶

Name	Type	Description	Notes
mode	WifiMode		optional

Returns¶

Nothing

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const mode = ...;
const response = await tap.service.wifi.putNetworkMode(mode);
const value = response.body();
console.log(`putNetworkMode: ${value}`);

getDisabled¶

Get Wi-Fi disable status

Parameters¶

This endpoint does not need any parameter.

Returns¶

boolean

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const response = await tap.service.wifi.getDisabled();
const value = response.body();
console.log(`getDisabled: ${value}`);

putDisabled¶

Write Wi-Fi disable status

Parameters¶

Name	Type	Description	Notes
isDisabled	boolean	true to disabled wifi	optional

Returns¶

Nothing

Example¶

Typescript

import { Tap } from "@iotize/tap";

const tap: Tap = ...;


const isDisabled = ...;
const response = await tap.service.wifi.putDisabled(isDisabled);
const value = response.body();
console.log(`putDisabled: ${value}`);