com.iotize.android.device.device.api.service.definition

Interface TargetService

public interface TargetService

Method Summary

Modifier and Type	Method and Description
Call<java.lang.Void>	clearComStats() Clear communication stats LWM2M path: /1027//11
Call<java.lang.Void>	connect() Connect to target LWM2M path: /1027//3
Call<java.lang.Void>	disconnect() Disconnect from target LWM2M path: /1027//4
Call<TargetComStats>	getComStats() Get communication stats Get Nb of failed communications and number of successful communications with Target LWM2M path: /1027//11
Call<TargetCoreType>	getCoreType() Get core type LWM2M path: /1027//2
Call<java.lang.Void>	getDebugAccess() Debug access Access registres de contrôle (SWD=>APDP) de la cible.
Call<java.lang.String>	getFirmwareVersion() Get firmware version LWM2M path: /1027//6
Call<java.lang.Integer>	getMaxVoltage() Get max voltage LWM2M path: /1027//9
Call<java.lang.Integer>	getMinVoltage() Get min voltage LWM2M path: /1027//8
Call<byte[]>	getModbusSubProtocol() Get current sub protocol LWM2M path: /1027//40
Call<java.lang.Integer>	getPageSize() Get page size Alignement page (TAR) LWM2M path: /1027//10
Call<TargetProtocol>	getProtocol() Get target protocol LWM2M path: /1027//1
Call<ListTargetProtocol>	getProtocolList() List available target protocols LWM2M path: /1027//20
Call<java.lang.Void>	getRegAccess() Register access Access registres (Cortex=>R0...R15) de la cible.
Call<UartSettings>	getUARTSettings() Données de config du protocole (baudrate MODBus, chainage JTAG, etc.)
Call<java.lang.Integer>	getVcc() Get vcc Lit la valeur de la tension de la cible LWM2M path: /1027//7
Call<byte[]>	modbusRead(MemoryInfo data) Generic modbus read LWM2M path: /1027//38
Call<java.lang.Void>	modbusWrite(MemoryWriteInfo data) Generic modbus write LWM2M path: /1027//37
Call<java.lang.Void>	postAdpAction(byte[] data) Perform actions to ADP target.
Call<java.lang.Void>	postDebugAccess() ???
Call<java.lang.Void>	postModbusSubProtocol(byte[] data) Set current sub protocol LWM2M path: /1027//40
Call<java.lang.Void>	postRegAccess() ???
Call<java.lang.Void>	postResetKeep() Reset target Reset de la cible (RST=0) et maintient en Reset.
Call<java.lang.Void>	putCoreType(TargetCoreType value) Write core type LWM2M path: /1027//2
Call<java.lang.Void>	putFirmwareVersion(java.lang.Integer value) Write firmware version LWM2M path: /1027//6
Call<java.lang.Void>	putMaxVoltage(java.lang.Integer value) Write max voltage value LWM2M path: /1027//9
Call<java.lang.Void>	putMinVoltage(java.lang.Integer value) Write min voltage value LWM2M path: /1027//8
Call<java.lang.Void>	putPageSize(java.lang.Integer value) Write page size LWM2M path: /1027//10
Call<java.lang.Void>	putProtocol(TargetProtocol targetProtocol) Write target protocol LWM2M path: /1027//1
Call<byte[]>	read() Read data transparent mode Lecture de données de la target en mode transparent ou semi-transparent si il y en a, sans attente.
Call<byte[]>	readAddress(MemoryInfo value) Read memory on target LWM2M path: /1030//13
Call<byte[]>	readBytes(java.lang.Integer nbBytes) Read data transparent mode with limit Lecture de données de la target en mode transparent ou semi-transparent si il y en a, sans attente.
Call<java.lang.Void>	reset() Reset target Reset de la cible.
Call<byte[]>	send(byte[] data) Transparent send Send data to the target application LWM2M path: /1027//34
Call<byte[]>	sendReceive(java.lang.Integer responseLength) Transparent send and receive Send data to the target application and expect response length LWM2M path: /1027//34
Call<java.lang.Void>	setUARTSettings(UartSettings value) Temporary update configuration Execute permet de changer la valeur (mais pas la taille) courante de manière temporaire.
Call<java.lang.Void>	writeAddress(MemoryWriteInfo value) Write into memory on target LWM2M path: /1030//13
Call<java.lang.Void>	writeUARTSettings(UartSettings value) Update configuration Put permet de changer la valeur (mais pas la taille) courante de manière permanente LWM2M path: /1027//21

Method Detail

clearComStats

@Post(value="/target/com-stats")
Call<java.lang.Void> clearComStats()

Clear communication stats LWM2M path: /1027//11

Returns:

api call

connect

@Post(value="/target/connect")
Call<java.lang.Void> connect()

Connect to target LWM2M path: /1027//3

Returns:

api call

disconnect

@Post(value="/target/disconnect")
Call<java.lang.Void> disconnect()

Disconnect from target LWM2M path: /1027//4

Returns:

api call

getComStats

@Get(value="/target/com-stats")
Call<TargetComStats> getComStats()

Get communication stats Get Nb of failed communications and number of successful communications with Target LWM2M path: /1027//11

Returns:

api call

getCoreType

@Get(value="/target/core-type")
Call<TargetCoreType> getCoreType()

Get core type LWM2M path: /1027//2

Returns:

api call

getDebugAccess

@Get(value="/target/debug-access")
Call<java.lang.Void> getDebugAccess()

Debug access Access registres de contrôle (SWD=>APDP) de la cible. Accès conditionné par les ACLs du Bundle Debug (-2) LWM2M path: /1027//31

Returns:

api call

getFirmwareVersion

@Get(value="/target/firmware-version")
Call<java.lang.String> getFirmwareVersion()

Get firmware version LWM2M path: /1027//6

Returns:

api call

getMaxVoltage

@Get(value="/target/max-voltage")
Call<java.lang.Integer> getMaxVoltage()

Get max voltage LWM2M path: /1027//9

Returns:

api call

getMinVoltage

@Get(value="/target/min-voltage")
Call<java.lang.Integer> getMinVoltage()

Get min voltage LWM2M path: /1027//8

Returns:

api call

getModbusSubProtocol

@Get(value="/target/modbus/sub-protocol")
Call<byte[]> getModbusSubProtocol()

Get current sub protocol LWM2M path: /1027//40

Returns:

api call

getPageSize

@Get(value="/target/page-size")
Call<java.lang.Integer> getPageSize()

Get page size Alignement page (TAR) LWM2M path: /1027//10

Returns:

api call

getProtocol

@Get(value="/target/protocol")
Call<TargetProtocol> getProtocol()

Get target protocol LWM2M path: /1027//1

Returns:

api call

getProtocolList

@Get(value="/target/protocol/list")
Call<ListTargetProtocol> getProtocolList()

List available target protocols LWM2M path: /1027//20

Returns:

api call

getRegAccess

@Get(value="/target/reg-access")
Call<java.lang.Void> getRegAccess()

Register access Access registres (Cortex=>R0...R15) de la cible. Accès conditionné par les ACLs du Bundle Debug (-2) LWM2M path: /1027//32

Returns:

api call

getUARTSettings

@Get(value="/target/uart/settings")
Call<UartSettings> getUARTSettings()

Données de config du protocole (baudrate MODBus, chainage JTAG, etc.) Taille variable, fixée au premier write après le reset factory. LWM2M path: /1027//21

Returns:

api call

getVcc

@Get(value="/target/vcc")
Call<java.lang.Integer> getVcc()

Get vcc Lit la valeur de la tension de la cible LWM2M path: /1027//7

Returns:

api call

modbusRead

@Get(value="/target/modbus/read")
Call<byte[]> modbusRead(@Body(converter="MemoryInfo")
                                                           MemoryInfo data)

Generic modbus read LWM2M path: /1027//38

Parameters:

data - input

Returns:

api call

modbusWrite

@Get(value="/target/modbus/write")
Call<java.lang.Void> modbusWrite(@Body(converter="MemoryWriteInfo")
                                                                     MemoryWriteInfo data)

Generic modbus write LWM2M path: /1027//37

Parameters:

data - input

Returns:

api call

postAdpAction

@Post(value="/target/adp/action")
Call<java.lang.Void> postAdpAction(@Body(converter="Bytes")
                                                                      byte[] data)

Perform actions to ADP target. LWM2M path: /1027//39

Parameters:

data - input

Returns:

api call

postDebugAccess

@Post(value="/target/debug-access")
Call<java.lang.Void> postDebugAccess()

??? LWM2M path: /1027//31

Returns:

api call

postModbusSubProtocol

@Post(value="/target/modbus/sub-protocol")
Call<java.lang.Void> postModbusSubProtocol(@Body(converter="Bytes")
                                                                                       byte[] data)

Set current sub protocol LWM2M path: /1027//40

Parameters:

data - input

Returns:

api call

postRegAccess

@Post(value="/target/reg-access")
Call<java.lang.Void> postRegAccess()

??? LWM2M path: /1027//32

Returns:

api call

postResetKeep

@Post(value="/target/reset-keep")
Call<java.lang.Void> postResetKeep()

Reset target Reset de la cible (RST=0) et maintient en Reset. Le relachement se fait par Reset (plus haut). Accès conditionné par les ACLs du Bundle réservé Debug (-2) si il existe, sinon Admin seulement LWM2M path: /1027//30

Returns:

api call

putCoreType

@Put(value="/target/core-type")
Call<java.lang.Void> putCoreType(@Body(converter="TargetCoreType")
                                                                  TargetCoreType value)

Write core type LWM2M path: /1027//2

Parameters:

value - input

Returns:

api call

putFirmwareVersion

@Put(value="/target/firmware-version")
Call<java.lang.Void> putFirmwareVersion(@Body(converter="integer_uint32")
                                                                                java.lang.Integer value)

Write firmware version LWM2M path: /1027//6

Parameters:

value - input

Returns:

api call

putMaxVoltage

@Put(value="/target/max-voltage")
Call<java.lang.Void> putMaxVoltage(@Body(converter="integer_uint16")
                                                                      java.lang.Integer value)

Write max voltage value LWM2M path: /1027//9

Parameters:

value - input

Returns:

api call

putMinVoltage

@Put(value="/target/min-voltage")
Call<java.lang.Void> putMinVoltage(@Body(converter="integer_uint16")
                                                                      java.lang.Integer value)

Write min voltage value LWM2M path: /1027//8

Parameters:

value - input

Returns:

api call

putPageSize

@Put(value="/target/page-size")
Call<java.lang.Void> putPageSize(@Body(converter="integer_uint32")
                                                                  java.lang.Integer value)

Write page size LWM2M path: /1027//10

Parameters:

value - input

Returns:

api call

putProtocol

@Put(value="/target/protocol")
Call<java.lang.Void> putProtocol(@Body(converter="TargetProtocol")
                                                                 TargetProtocol targetProtocol)

Write target protocol LWM2M path: /1027//1

Parameters:

targetProtocol - input

Returns:

api call

read

@Get(value="/target/transparent/read")
Call<byte[]> read()

Read data transparent mode Lecture de données de la target en mode transparent ou semi-transparent si il y en a, sans attente. LWM2M path: /1027//35

Returns:

api call

readAddress

@Get(value="/target/memaccess")
Call<byte[]> readAddress(@Body(converter="MemoryInfo")
                                                          MemoryInfo value)

Read memory on target LWM2M path: /1030//13

Parameters:

value - input

Returns:

api call

readBytes

@Get(value="/target/transparent/read-bytes")
Call<byte[]> readBytes(@Body(converter="integer_uint32")
                                                                     java.lang.Integer nbBytes)

Read data transparent mode with limit Lecture de données de la target en mode transparent ou semi-transparent si il y en a, sans attente. LWM2M path: /1027//35

Parameters:

nbBytes - input

Returns:

api call

reset

@Post(value="/target/reset")
Call<java.lang.Void> reset()

Reset target Reset de la cible. (Reset =0, wait, Reset = 1) utilisé pour relacher le reset après utilisation de ResetKeep. Accès conditionné par les ACLs du Bundle Debug (-2) LWM2M path: /1027//5

Returns:

api call

send

@Post(value="/target/transparent/send")
Call<byte[]> send(@Body(converter="Bytes")
                                                           byte[] data)

Transparent send Send data to the target application LWM2M path: /1027//34

Parameters:

data - input

Returns:

api call

sendReceive

@Get(value="/target/transparent/send-receive")
Call<byte[]> sendReceive(@Body(converter="integer_uint16")
                                                                         java.lang.Integer responseLength)

Transparent send and receive Send data to the target application and expect response length LWM2M path: /1027//34

Parameters:

responseLength - input

Returns:

api call

setUARTSettings

@Post(value="/target/uart/settings")
Call<java.lang.Void> setUARTSettings(@Body(converter="UartSettings")
                                                                           UartSettings value)

Temporary update configuration Execute permet de changer la valeur (mais pas la taille) courante de manière temporaire. Elle sera réinitialisée au reset d'après la valeur configurée. LWM2M path: /1027//21

Parameters:

value - input

Returns:

api call

writeAddress

@Post(value="/target/memaccess")
Call<java.lang.Void> writeAddress(@Body(converter="MemoryWriteInfo")
                                                                    MemoryWriteInfo value)

Write into memory on target LWM2M path: /1030//13

Parameters:

value - input

Returns:

api call

writeUARTSettings

@Put(value="/target/uart/settings")
Call<java.lang.Void> writeUARTSettings(@Body(converter="UartSettings")
                                                                            UartSettings value)

Update configuration Put permet de changer la valeur (mais pas la taille) courante de manière permanente LWM2M path: /1027//21

Parameters:

value - input

Returns:

api call