Skip to content

Enum Types

Enum VariableFormat

Name Description
_1_bit
_8_bits
_16_bits
_32_bits

Enum AvailablePowerSource

Name Description
dc_power
s3p
ac_external_power

Enum FirmwareState

Name Description
normal
updating
updated

Enum FirmwareUpdateResult

Name Description
default_value
update_successful
not_enough_memory
out_of_memory
connection_lost
crc_check_failure
unsupported_package_type
invalid_uri

Enum HostProtocol

Name Description
nfc
bluetooth
gsm
usb_rlink
usb_cmisis_dap
wifi
ble

Enum LowPowerOptimisationLevel

Name Description
no
standby
shutdown

Enum NetworkMode

Name Description
peer_to_peer
infrastructure_only
infrastructure_cloud

Enum CloudConnectionMode

Name Description
generic
ibm_bluemix
microsoft_azure
amazon_aws

Enum TargetProtocol

Name Description
swd
s3p
jtag
modbus
gpio
serial_standard
serial_via_tapnpass
none

Enum CoreType

Name Description
m0_cortex
m2_cortex
m3_cortex

Enum NfcPairingMode

Name Description
no
mandatory
mandatory_for_login

Enum TargetCoreType

Name Description
m0_cortex
m1_cortex

Enum SpecialFeature

Name Description
SWD_DIRECT_ACCESS
SERIAL_ACCESS
MODBUS_DIRECT_ACCESS
TAPNPASS_CONTROL_ACCESS
SP_CODEEXEC_ACCESS

Model AclEntry

Name Type Description
create Bool
delete Bool
execute Bool
write Bool
read Bool

Model MemoryInfo

Name Type Description
address UInt32 Address
length UInt32 Number of word
format VariableFormat Size of one word

Model MemoryWriteInfo

Name Type Description
info MemoryInfo
data Bytes

Model ReadWriteRights

Name Type Description
groupId UInt16
write Bool
read Bool

Model DataLogOption

Regroups data log options

Name Type Description
security Bool True if packets are stored encrypted
qos Bool Quality Of Service
logOnChange Bool True to create a new data log packet when value change
rollingMode Bool
autorun Bool True to automatically run data log when tap is powered on

Model UartSettings

You must reverse bytes order coming from the tap when using this definition file. This is due to the fact that the TapNPass store the uart settings in registers and directly send it's memory content. As memory is in little endian, reversing the make it works

Name Type Description
slv UInt8
ofs Bool
baudRate Int
physicalPort PhysicalPort
stopBit StopBit
bitParity BitParity
dataBitsLength DataBitsLength
handshakeDelimiter HandshakeDelimiter
handshakeValue Handshake
timeout UInt8

Enum BitParity

Name Description
none
odd
even

Enum Handshake

Name Description
none
rts
cts
rts_cts

Enum StopBit

Name Description
one
one_and_half
two

Enum PhysicalPort

Name Description
none
rs232
usb
auto
rs485

Enum HandshakeDelimiter

Name Description
none
cr
lf
cr_lf

Enum DataBitsLength

Name Description
_7
_8
_9

Model TapVersion

Name Type Description
major UInt8
minor UInt8
patch UInt16

Model Lwm2mTlv

Name Type Description
identifierType UInt8 00= Object Instance in which case the Value contains one or more Resource TLVs 01= Resource Instance with Value for use within a multiple Resource TLV 10= multiple Resource, in which case the Value contains one or more Resource Instance TLVs 11= Resource with Value
identifierLength Bool Indicates the Length of the Identifier. 0=The Identifier field of this TLV is 8 bits long 1=The Identifier field of this TLV is 16 bits long
lengthType UInt8 00=No length field, the value immediately follows the Identifier field in is of the length indicated by Bits 2-0 of this field 01 = The Length field is 8-bits and Bits 2-0 MUST be ignored 10 = The Length field is 16-bits and Bits 2-0 MUST be ignored 11 = The Length field is 24-bits and Bits 2-0 MUST be ignored
other UInt8 A 3-bit unsigned integer indicating the Length of the Value.
identifier Bytes
len UInt16
value Bytes

Model InterfaceLock

Name Type Description
scramActivated Bool true if scram is activated
hashPassword Bool true if login is done using the hash of the password instead of the password itself
factoryReset Bool true to disable factory reset using hardware
resourceLogUid Bool true to disable login using UID (resource /1024//5)
resourceFactory Bool true to disable factory reset using LwM2M resource

Model LoginCredential

Name Type Description
username String
password String

Model LoginCredentialHashed

Name Type Description
username String
password Bytes

Model ScramLoginParams

Name Type Description
username String
clientNonce UInt32

Model ScramLoginResponseBody

Name Type Description
serverNonce UInt32
salt Bytes
iterationNumber UInt32

Model TargetComStats

Name Type Description
nbFailCom UInt32
nbSuccessfulCom UInt32

Model AvailableFunction

Name Type Description
debug Bool
dataLog Bool

Model MultiRequest

Name Type Description
requests RequestItem

Model request_item

Name Type Description
requestLen UInt16
request TapRequest
expectedCodeRet UInt8

Enum ExpectedResultCode

Name Description
success
anything

Model MultiResponse

Name Type Description
responses ResponseItem

Model response_item

Name Type Description
responseLen UInt16
response TapResponse

Model CrcCheckBody

Name Type Description
address UInt32
size UInt32
crc UInt32

Model SinglePacket

Name Type Description
sendTime UInt32
packetLength UInt16 Packet length is full size expect send_time.
packetId UInt16
configVersion UInt32
messageType PacketType
encryption Bool
ack Bool
senderId UInt8
salt UInt16
logTime UInt32
dataSize UInt16
data Bytes
padding Bytes Padding on 4 bytes (usefull to compute CRC)
crc UInt32 CRC32 is computed starting from field packet_length

Enum PacketType

Name Description
mask
data_log
command
code_exec
conf_update
security_token
target_fw_update

Model AclEntries

Name Type Description
items AclEntry

Model LoraConfig

LoRa conf to activate log, SP, �

Name Type Description
classA Bool
classB Bool
classC Bool
dataLoggingEnabled Bool
singlePacketEnabled Bool

Model SinglePacketPart

Name Type Description
len UInt16 Number of 16 bytes word
offset UInt16 Offset in 16 bytes words
data Bytes

Model ModbusOptions

Name Type Description
objectType ObjectType Modbus object type
slave UInt8 Slave address
address UInt16 Modbus address to read
length UInt32 Number of word to read
format VariableFormat Variable format (only on for variables)

Enum ObjectType

Name Description
default
coil
discret_input
holding_register
input_register

Model ModbusWriteOptions

Name Type Description
options ModbusOptions
data Bytes Modbus data

Model SinglePacketStoreInfo

Name Type Description
state State

Enum State

Name Description
unavailable
empty
used
full
error

Model AdpControlIn

Name Type Description
command Command
param UInt16

Enum Command

Name Description
none
zip
unzip

Model AdpControlOut

Name Type Description
resultCode ResultCode Result code
param UInt16

Enum ResultCode

Name Description
none
ok
zip_timeout
unzip_timeout
zip_error
unzip_error
unknown_command