TargetService¶

Method	LwM2M request	Description
getProtocol	get /1027//1 alias: /target/protocol	Get target protocol
setProtocol	post /1027//1 alias: /target/protocol	Temporarily change target protocol
putProtocol	put /1027//1 alias: /target/protocol	Write target protocol in configuration
getCoreType	get /1027//2 alias: /target/core-type	Get core type
putCoreType	put /1027//2 alias: /target/core-type	Write core type
isConnected	get /1027//3 alias: /target/connect	Read target protocol connection status
connect	post /1027//3 alias: /target/connect	Connect to target
disconnect	post /1027//4 alias: /target/disconnect	Disconnect from target
reset	post /1027//5 alias: /target/reset	Reset target
getFirmwareVersion	get /1027//6 alias: /target/firmware-version	Get target firmware version
putFirmwareVersion	put /1027//6 alias: /target/firmware-version	Write target firmware version
getVcc	get /1027//7 alias: /target/vcc	Get vcc
getMinVoltage	get /1027//8 alias: /target/min-voltage	Get min target voltage
putMinVoltage	put /1027//8 alias: /target/min-voltage	Write min target voltage value
getMaxVoltage	get /1027//9 alias: /target/max-voltage	Get max target voltage
putMaxVoltage	put /1027//9 alias: /target/max-voltage	Write max target voltage value
getPageSize	get /1027//10 alias: /target/page-size	Get target page size
putPageSize	put /1027//10 alias: /target/page-size	Write target page size
getComStats	get /1027//11 alias: /target/com-stats	Get communication stats
clearComStats	post /1027//11 alias: /target/com-stats	Clear communication stats
getAvailableProtocols	get /1027//20 alias: /target/available-protocols	List available target protocols
getSerialModbusConfiguration	get /1027//21 alias: /target/serial-modbus-configuration	Get Serial/Modbus protocol configuration options
setSerialModbusConfiguration	post /1027//21 alias: /target/serial-modbus-configuration	Temporary update configuration
putSerialModbusConfiguration	put /1027//21 alias: /target/serial-modbus-configuration	Write protocol options in Tap configuration
getModbusDefaultSlaveAddress	get /1027//22 alias: /target/modbus-default-slave-address	Get modbus default slave address
putModbusDefaultSlaveAddress	put /1027//22 alias: /target/modbus-default-slave-address	Write modbus default slave address
getS3PConfiguration	get /1027//21 alias: /target/s3p-configuration	Get S3P protocol configuration
setS3PConfiguration	post /1027//21 alias: /target/s3p-configuration	Temporary update S3P configuration
putS3PConfiguration	put /1027//21 alias: /target/s3p-configuration	Update protocol configuration
getModbusTcpConfiguration	get /1027//21 alias: /target/modbus-tcp-configuration	Get Modbus TCP protocol configuration
setModbusTcpConfiguration	post /1027//21 alias: /target/modbus-tcp-configuration	Temporary update Modbus TCP configuration
putModbusTcpConfiguration	put /1027//21 alias: /target/modbus-tcp-configuration	Update Modbus TCP configuration
getCanConfiguration	get /1027//21 alias: /target/can-configuration	Get CAN protocol configuration
setCanConfiguration	post /1027//21 alias: /target/can-configuration	Temporary update CAN configuration
putCanConfiguration	put /1027//21 alias: /target/can-configuration	Update CAN protocol configuration
postResetKeep	post /1027//30 alias: /target/reset-keep	Put and keep target in Reset state
readDebug	get /1027//31 alias: /target/debug-access	Debug access
writeDebug	post /1027//31 alias: /target/debug-access	Write address
getRegisterAccess	get /1027//32 alias: /target/register-access	Register access
postRegisterAccess	post /1027//32 alias: /target/register-access	Write register value
sendReceive	get /1027//34 alias: /target/transparent/send-receive	Transparent send and receive
send	post /1027//34 alias: /target/transparent/send	Transparent send
readBytes	get /1027//35 alias: /target/transparent/read-bytes	Read data transparent mode with limit
modbusWrite	post /1027//37 alias: /target/modbus/write	Direct modbus write
modbusRead	get /1027//38 alias: /target/modbus/read	Direct modbus read
getSubProtocol	get /1027//40 alias: /target/sub-protocol	Get current sub protocol
getReceivedCount	get /1027//43 alias: /target/received-count	Get byte length received in buffer
readAddress	get /1027//33 alias: /target/read-address	SWD direct Read
writeAddress	post /1027//33 alias: /target/read-address	SWD direct Write

getProtocol¶

Get target protocol

Parameters¶

This endpoint does not need any parameter.

Returns¶

TargetProtocol

Example¶

Typescript

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

const tap: Tap = ...;


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

setProtocol¶

Temporarily change target protocol

Parameters¶

Name	Type	Description	Notes
targetProtocol	TargetProtocol	TargetProtocol object to set

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


const targetProtocol = ...;
const response = await tap.service.target.setProtocol(targetProtocol);
const value = response.body();
console.log(`setProtocol: ${value}`);

putProtocol¶

Write target protocol in configuration

Parameters¶

Name	Type	Description	Notes
targetProtocol	TargetProtocol	TargetProtocol object to set

Returns¶

Nothing

Authorization¶

Configuration mode is required to perform this request.

Example¶

Typescript

import { Tap } from "@iotize/tap";
import '@iotize/tap/ext/configurator';


const tap: Tap = ...;

await tap.configurator.setupConfigMode();

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

getCoreType¶

Get core type

Parameters¶

This endpoint does not need any parameter.

Returns¶

TargetCoreType

Example¶

Typescript

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

const tap: Tap = ...;


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

putCoreType¶

Write core type

Parameters¶

Name	Type	Description	Notes
value	TargetCoreType	Write core type

Returns¶

Nothing

Authorization¶

Configuration mode is required to perform this request.

Example¶

Typescript

import { Tap } from "@iotize/tap";
import '@iotize/tap/ext/configurator';


const tap: Tap = ...;

await tap.configurator.setupConfigMode();

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

isConnected¶

Read target protocol connection 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.target.isConnected();
const value = response.body();
console.log(`isConnected: ${value}`);

connect¶

Connect to target

Parameters¶

This endpoint does not need any parameter.

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

disconnect¶

Disconnect from target

Parameters¶

This endpoint does not need any parameter.

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

reset¶

Reset target

Parameters¶

This endpoint does not need any parameter.

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

getFirmwareVersion¶

Get target firmware version

Parameters¶

This endpoint does not need any parameter.

Returns¶

string (version)

Example¶

Typescript

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

const tap: Tap = ...;


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

putFirmwareVersion¶

Write target firmware version

Parameters¶

Name	Type	Description	Notes
value	string

Returns¶

Nothing

Authorization¶

Configuration mode is required to perform this request.

Example¶

Typescript

import { Tap } from "@iotize/tap";
import '@iotize/tap/ext/configurator';


const tap: Tap = ...;

await tap.configurator.setupConfigMode();

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

getVcc¶

Get vcc

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.target.getVcc();
const value = response.body();
console.log(`getVcc: ${value}`);

getMinVoltage¶

Get min target voltage

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.target.getMinVoltage();
const value = response.body();
console.log(`getMinVoltage: ${value}`);

putMinVoltage¶

Write min target voltage value

Parameters¶

Name	Type	Description	Notes
value	number

Returns¶

Nothing

Authorization¶

Configuration mode is required to perform this request.

Example¶

Typescript

import { Tap } from "@iotize/tap";
import '@iotize/tap/ext/configurator';


const tap: Tap = ...;

await tap.configurator.setupConfigMode();

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

getMaxVoltage¶

Get max target voltage

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.target.getMaxVoltage();
const value = response.body();
console.log(`getMaxVoltage: ${value}`);

putMaxVoltage¶

Write max target voltage value

Parameters¶

Name	Type	Description	Notes
value	number

Returns¶

Nothing

Authorization¶

Configuration mode is required to perform this request.

Example¶

Typescript

import { Tap } from "@iotize/tap";
import '@iotize/tap/ext/configurator';


const tap: Tap = ...;

await tap.configurator.setupConfigMode();

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

getPageSize¶

Get target page size

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint32)

Example¶

Typescript

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

const tap: Tap = ...;


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

putPageSize¶

Write target page size

Parameters¶

Name	Type	Description	Notes
value	number

Returns¶

Nothing

Authorization¶

Configuration mode is required to perform this request.

Example¶

Typescript

import { Tap } from "@iotize/tap";
import '@iotize/tap/ext/configurator';


const tap: Tap = ...;

await tap.configurator.setupConfigMode();

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

getComStats¶

Get communication stats

Parameters¶

This endpoint does not need any parameter.

Returns¶

TargetComStats

Example¶

Typescript

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

const tap: Tap = ...;


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

clearComStats¶

Clear communication stats

Parameters¶

This endpoint does not need any parameter.

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

getAvailableProtocols¶

List available target protocols

Parameters¶

This endpoint does not need any parameter.

Returns¶

TargetProtocol[]

Example¶

Typescript

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

const tap: Tap = ...;


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

getSerialModbusConfiguration¶

Get Serial/Modbus protocol configuration options

Parameters¶

This endpoint does not need any parameter.

Returns¶

TargetSerialModbusProtocolConfiguration

Example¶

Typescript

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

const tap: Tap = ...;


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

setSerialModbusConfiguration¶

Temporary update configuration

Parameters¶

Name	Type	Description	Notes
value	TargetSerialModbusProtocolConfiguration

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

putSerialModbusConfiguration¶

Write protocol options in Tap configuration

Parameters¶

Name	Type	Description	Notes
value	TargetSerialModbusProtocolConfiguration

Returns¶

Nothing

Authorization¶

Configuration mode is required to perform this request.

Example¶

Typescript

import { Tap } from "@iotize/tap";
import '@iotize/tap/ext/configurator';


const tap: Tap = ...;

await tap.configurator.setupConfigMode();

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

getModbusDefaultSlaveAddress¶

Get modbus default slave address

Parameters¶

This endpoint does not need any parameter.

Returns¶

number (uint32)

Example¶

Typescript

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

const tap: Tap = ...;


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

putModbusDefaultSlaveAddress¶

Write modbus default slave address

Parameters¶

Name	Type	Description	Notes
address	number	New default modbus slave address

Returns¶

Nothing

Authorization¶

Configuration mode is required to perform this request.

Example¶

Typescript

import { Tap } from "@iotize/tap";
import '@iotize/tap/ext/configurator';


const tap: Tap = ...;

await tap.configurator.setupConfigMode();

const address = ...;
const response = await tap.service.target.putModbusDefaultSlaveAddress(address);
const value = response.body();
console.log(`putModbusDefaultSlaveAddress: ${value}`);

getS3PConfiguration¶

Get S3P protocol configuration

Parameters¶

This endpoint does not need any parameter.

Returns¶

TargetS3PProtocolConfiguration

Example¶

Typescript

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

const tap: Tap = ...;


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

setS3PConfiguration¶

Temporary update S3P configuration

Parameters¶

Name	Type	Description	Notes
value	TargetS3PProtocolConfiguration

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

putS3PConfiguration¶

Update protocol configuration

Parameters¶

Name	Type	Description	Notes
value	TargetS3PProtocolConfiguration

Returns¶

Nothing

Authorization¶

Configuration mode is required to perform this request.

Example¶

Typescript

import { Tap } from "@iotize/tap";
import '@iotize/tap/ext/configurator';


const tap: Tap = ...;

await tap.configurator.setupConfigMode();

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

getModbusTcpConfiguration¶

Get Modbus TCP protocol configuration

Parameters¶

This endpoint does not need any parameter.

Returns¶

TargetModbusTcpProtocolConfiguration

Example¶

Typescript

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

const tap: Tap = ...;


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

setModbusTcpConfiguration¶

Temporary update Modbus TCP configuration

Parameters¶

Name	Type	Description	Notes
value	TargetModbusTcpProtocolConfiguration

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

putModbusTcpConfiguration¶

Update Modbus TCP configuration

Parameters¶

Name	Type	Description	Notes
value	TargetModbusTcpProtocolConfiguration

Returns¶

Nothing

Authorization¶

Configuration mode is required to perform this request.

Example¶

Typescript

import { Tap } from "@iotize/tap";
import '@iotize/tap/ext/configurator';


const tap: Tap = ...;

await tap.configurator.setupConfigMode();

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

getCanConfiguration¶

Get CAN protocol configuration

Parameters¶

This endpoint does not need any parameter.

Returns¶

TargetCanProtocolConfiguration

Example¶

Typescript

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

const tap: Tap = ...;


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

setCanConfiguration¶

Temporary update CAN configuration

Parameters¶

Name	Type	Description	Notes
value	TargetCanProtocolConfiguration

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

putCanConfiguration¶

Update CAN protocol configuration

Parameters¶

Name	Type	Description	Notes
value	TargetCanProtocolConfiguration

Returns¶

Nothing

Authorization¶

Configuration mode is required to perform this request.

Example¶

Typescript

import { Tap } from "@iotize/tap";
import '@iotize/tap/ext/configurator';


const tap: Tap = ...;

await tap.configurator.setupConfigMode();

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

postResetKeep¶

Put and keep target in Reset state

Parameters¶

This endpoint does not need any parameter.

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

readDebug¶

Debug access

Parameters¶

Name	Type	Description	Notes
address	number

Returns¶

Uint8Array

Example¶

Typescript

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

const tap: Tap = ...;


const address = ...;
const response = await tap.service.target.readDebug(address);
const value = response.body();
console.log(`readDebug: ${value}`);

writeDebug¶

Write address

Parameters¶

This endpoint does not need any parameter.

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

getRegisterAccess¶

Register access

Parameters¶

This endpoint does not need any parameter.

Returns¶

Uint8Array

Example¶

Typescript

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

const tap: Tap = ...;


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

postRegisterAccess¶

Write register value

Parameters¶

This endpoint does not need any parameter.

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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

sendReceive¶

Transparent send and receive

Parameters¶

Name	Type	Description	Notes
data	Uint8Array

Returns¶

Uint8Array

Example¶

Typescript

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

const tap: Tap = ...;


const data = ...;
const response = await tap.service.target.sendReceive(data);
const value = response.body();
console.log(`sendReceive: ${value}`);

send¶

Transparent send

Parameters¶

Name	Type	Description	Notes
data	Uint8Array

Returns¶

Uint8Array

Example¶

Typescript

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

const tap: Tap = ...;


const data = ...;
const response = await tap.service.target.send(data);
const value = response.body();
console.log(`send: ${value}`);

readBytes¶

Read data transparent mode with limit

Parameters¶

This endpoint does not need any parameter.

Returns¶

Uint8Array

Example¶

Typescript

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

const tap: Tap = ...;


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

modbusWrite¶

Direct modbus write

Parameters¶

Name	Type	Description	Notes
data	ModbusWriteOptions

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


const data = ...;
const response = await tap.service.target.modbusWrite(data);
const value = response.body();
console.log(`modbusWrite: ${value}`);

modbusRead¶

Direct modbus read

Parameters¶

Name	Type	Description	Notes
data	ModbusOptions

Returns¶

Uint8Array

Example¶

Typescript

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

const tap: Tap = ...;


const data = ...;
const response = await tap.service.target.modbusRead(data);
const value = response.body();
console.log(`modbusRead: ${value}`);

getSubProtocol¶

Get current sub protocol

Parameters¶

This endpoint does not need any parameter.

Returns¶

TargetProtocol

Example¶

Typescript

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

const tap: Tap = ...;


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

getReceivedCount¶

Get byte length received in buffer

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.target.getReceivedCount();
const value = response.body();
console.log(`getReceivedCount: ${value}`);

readAddress¶

SWD direct Read

Parameters¶

Name	Type	Description	Notes
value	MemoryInfo

Returns¶

Uint8Array

Example¶

Typescript

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

const tap: Tap = ...;


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

writeAddress¶

SWD direct Write

Parameters¶

Name	Type	Description	Notes
value	MemoryWriteInfo

Returns¶

Nothing

Example¶

Typescript

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

const tap: Tap = ...;


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