User Manual TREK-120ANR NFC reader
Copyright The documentation and the software included with this product are copyrighted 2019 by Advantech Co., Ltd. All rights are reserved. Advantech Co., Ltd. reserves the right to make improvements in the products described in this manual at any time without notice. No part of this manual may be reproduced, copied, translated or transmitted in any form or by any means without the prior written permission of Advantech Co., Ltd. Information provided in this manual is intended to be accurate and reliable.
Declaration of Conformity CE This product has passed the CE test for environmental specifications. Test conditions for passing included the equipment being operated within an industrial enclosure. In order to protect the product from being damaged by ESD (Electrostatic Discharge) and EMI leakage, we strongly recommend the use of CE-compliant industrial enclosure products.
Changes or modifications not expressly approved by the party responsible for compliance could void the user`s authority to operate the equipment. . Technical Support and Assistance 1. 2. Visit the Advantech web site at http://support.advantech.com where you can find the latest information about the product. Contact your distributor, sales representative, or Advantech's customer service center for technical support if you need additional assistance.
Warnings, Cautions and Notes Warning! Warnings indicate conditions, which if not observed, can cause personal injury! Caution! Cautions are included to help you avoid damaging hardware or losing data. e.g. There is a danger of a new battery exploding if it is incorrectly installed. Do not attempt to recharge, force open, or heat the battery. Replace the battery only with the same or equivalent type recommended by the manufacturer. Discard used batteries according to the manufacturer's instructions.
Ordering Information Part Number TREK-120-ANR000A00 Description Cold Chain NFC reader Safety Instructions 1. 2. 3. 6. Read these safety instructions carefully. Keep this User Manual for later reference. Keep this equipment away from fire. Do not leave this equipment in an environment unconditioned, it may damage the equipment. Operating temperature: -20°C~70°C. 8. Do not operate this equipment in an environment temperature may over 70°C(149° F). The surface temperature of plastic chassis may be hot. 9.
Safety Precaution - Static Electricity Follow these simple precautions to protect yourself from harm and the products from damage. „ To avoid electrical shock, always disconnect the power from your PC chassis before you work on it. Don't touch any components on the mainboard or other cards while the system is on. „ Disconnect power before making any configuration changes. The sudden rush of power as you connect a jumper or install a card may damage sensitive electronic components.
Chapter 1 1 General Information This chapter gives background information on the TREK-120 Cold chain Sensor Sections include: „ Introduction „ General Specifications „ Dimensions
To withstand operation in refrigerated vehicles and cold chain logistics fleets, the TREK-120 sensors are IP65 rated for protection from water and dust ingress and support a wide operating temperature range (20 ~ 65 °C/-4 ~ 149 °F). Moreover, the sensor design is compact, lightweight (108 g), and cableless, and can be easily installed using magnets or an adhesive backing, eliminating the need for additional cables and invasive vehicle modifications.
NFC reader General Information Figure 1.1 TREK-120 dimensions Chapter 1 1.
Chapter 2 2 System Setup This chapter details system setup on TREK-120 Sections include: A Quick Tour of TREK-120 Installation Procedures
Installation Procedures 2.2.1 Setup TREK-120 NFC reader Chapter 2 2.1 A Quick Tour of TREK-120 a. Connect NFC reader to a PC or notebook USB port. System Setup b. Download Cold Chain SDK from the website : c. Unzip SDK file (Password is the same as the file name) and Launch coldchain_demo.exe. d. Go to “Setting”, and then select COM port which NFC reader connected then press “Open”. 2.2.2 Setup TREK-120 Temperature/humidity sensor a. Put TREK-120 on the NFC reader.
b. Go to “ Configure” to setup TREK-120. When you finish all the setting. Please press “Configure Loggers”. All the setting will be written into TREK-120. Press “ Start logger” , then the TREK-120 will start record temperature/humidity. Press “ Stop logger”, then the TREK-120 will be stopped record. c. Go to “Check” to check the configuration of the TREK-120. d. Go to “Download” to download all data in the TREK-120.
data will be shown on the screen. You also can export to .CSV file to save in other disk.
Chapter 6 Cold Chain API This chapter explains the software API for TREK-120 3
3.1 Introductions SDK Overview The SDK is divided into three parts BIN DLL Sample code DLL provides logic to communicate with the Logger module, most of the developers do not need to know the details, only need to corresponding process after the interest event trigger or Read/Write logger sensor. System Requirement OS Windows 7/8/10 Software Visual Studio 2015 .NET Framework 4.
When the instance is created, the user needs to call the coldchain_init(COM_Port) or coldchain_gateway_init(COM_Port) method to open the corresponding Serial Port. When the module is turned on, the system will be initialized in the background. When the initialization is complete, the user should be able to get the firmware version through coldchain_get_version() or coldchain_gateway_get_version().
Description: Get the version of firmware. Members: lib_version Point to coldchain_lib Version. device_firmware_version Point to NFC Reader OR LoRa Gateway Version. driver_api_version Point to Jogtek RFID.DLL API Version. Setting_Logger Structure Syntax: Windows: Description: Configure logger sensor internal information. Members: record_interval_minutes Set Logger sensor record interval (minutes). temperature_alarm_upper_bound Set logger sensor temperature alarm upper.
Set logger sensor temperature alarm lower. temperature_alarm_frequency Set logger sensor temperature alarm frequency. temperature_alarm_mode Temperature according to alarm frequency select type. Please refer to AlarmMode Enum. button_activate Press button to start logger sensor. Please refer to ButtonActivate Enum. button_datafull_restart Press button to restart logger sensor when record data full. Please refer to ButtonActivate Enum. humidity_alarm_upper_bound Set logger sensor humidity alarm upper.
Description: Get logger sensor internal information. Members: uid The logger sensor UID number. button_activate Button start or restart logger sensor. Please refer to ButtonActivate Enum. first_record_datetime Logger sensor the first record time stamp. record_index Logger sensor record count. record_interval_minutes Logger sensor record interval (minutes). temperature_alarm_upper_bound Logger sensor temperature alarm upper. temperature_alarm_lower_bound Logger sensor temperature alarm lower.
Please refer to AlarmMode Enum. sensor_status logger sensor status. Please refer to SensorState Enum. internal_battery_voltage Internal battery voltage. external_battery_voltage External battery voltage. sensor_firmware_version Logger sensor firmware version. humidity_alarm_upper_bound Logger sensor humidity alarm upper. humidity_alarm_lower_bound Logger sensor humidity alarm lower. humidity_alarm_frequency Logger sensor humidity alarm frequency.
Sensor_Internal_data Structure Syntax: Windows: public struct Sensor_Internal_data { public string uid; public int record_index; public DateTime[] record_datetime; public double[] temperature; public int temperature_alarm_upper_bound; public int temperature_alarm_lower_bound; public WarningType[] temperature_Warning; public double[] humidity; public int humidity_alarm_upper_bound; public int humidity_alarm_lower_bound; public WarningType[] humidity_Warning; public double internal_battery_voltage; public
Description: Get logger sensor record temperature and humidity information. Members: uid The logger sensor UID number. record_index Logger sensor record count. record_datetime[] One array. Record each data timestamp. temperature[] One array. Record each data temperature. temperature_alarm_upper_bound logger sensor temperature alarm upper. temperature_alarm_lower_bound logger sensor temperature alarm lower. temperature_Warning Judgment temperature alarm status. Please refer to WarningType Enum.
Record each data humidity. humidity_alarm_upper_bound logger sensor humidity alarm upper. humidity_alarm_lower_bound logger sensor humidity alarm lower. humidity_Warning Judgment humidity alarm status. Please refer to WarningType Enum. internal_battery_voltage Internal battery voltage. external_battery_voltage External battery voltage. falling_record_index Logger sensor falling count. falling_datetime[] One array. Record each falling data timestamp.
Sensor_LoRa_data Structure Windows: public struct Sensor_LoRa_data { public string uid; public int record_index; public string record_datetime; public double temperature; public double humidity; public double internal_battery_voltage; public double external_battery_voltage; public int falling_record_index; public string falling_datetime; public int rssi; public int snr; public int crc; public string external_battery_life; public string firmware_version; public Overflow_Flag over_alert; } Description: R
Members: uid The loRa sensor UID number. record_index LoRa sensor record count. record_datetime Receive data timestamp. temperature Receive data temperature. humidity Receive data humidity. internal_battery_voltage Internal battery voltage. external_battery_voltage External battery voltage. falling_record_index LoRa sensor falling count. falling_datetime Receive falling data timestamp. rssi The received signal strength indication.
The signal to noise ratio. crc The cyclic redundancy check. external_battery_life Shows the percentage of external voltage. firmware_version LoRa sensor version. over_alert The LoRA sensor overflow flag. Please refer to Overflow_Flag Structure.
Overflow_Flag Structure Windows: public struct Overflow_Flag { public bool temperature_overflow; public bool humidity_overflow; public bool falling_overflow; public bool record_index_overflow; public bool falling_record_index_overflow; public bool lora_transmission_stop; public bool internal_battery_low; public bool external_battery_low;; } Description: Save the LoRA sensor overflow flag. Members: temperature_overflow The temperature has exceeded the limit.
record_index_overflow The number of temperature and humidity pens has reached 2000. falling_record_index_overflow The number of falling pens has reached 30. lora_transmission_stop The external battery voltage is lower than the voltage configuration value before wireless transmission. internal_battery_low The internal battery voltage has been lower than 2.4v in front of the wireless transmission external_battery_low Set the external voltage limit, stop LoRa transmission.
StartTime Structure Windows: public struct StartTime { public bool auto_startup; public int date; public int hour; public int minute; public int second; } Description: Save the LoRA sensor overflow flag. Members: auto_startup Enable / Disable Appointment Time Function. date Setting Date time. hour Setting Hour time. minute Setting Minute time.
second Setting Second time.
APIs NFC Reader coldchain_init Syntax: Windows public int coldchain_init(string COM_Port) Description: Open the NFC Reader through the serial port. Parameters: COM_Port [in] Specifies which Serial Port Path to connect firmware. For example "COM1" Returns: ADVCC_ERR_SUCCESS - On success. Otherwise see the error code list.
coldchain_deinit Syntax: Windows public int coldchain_deinit() Description: Close NFC Reader the serial port. Parameters: None Returns: ADVCC_ERR_SUCCESS - On success. Otherwise see the error code list.
coldchain_get_version Syntax: Windows public int coldchain_get_version(ref Version FirmwareVer) Description: Get the version of firmware. Parameters: FirmwareVer [out] Please refer to Version Structure. Returns: MRM_ERR_NO_ERROR - On success. Otherwise see the error code list.
coldchain_set_logger Syntax: Windows public int coldchain_set_logger(Setting_Logger Logger) Description: Configure logger sensor internal information. Parameters: Logger [in] Please refer to Setting_Logger Structure. Returns: MRM_ERR_NO_ERROR - On success. Otherwise see the error code list. Remark: The lora_channel and lora_data_rate must be the same as the Gateway setting to receive.
coldchain_start_logger Syntax: Windows public int coldchain_start_logger() Description: Start logger sensor to record data. Parameters: None Returns: MRM_ERR_NO_ERROR - On success. Otherwise see the error code list.
coldchain_stop_logger Syntax: Windows public int coldchain_stop_logger() Description: Stop logger sensor. Parameters: None Returns: MRM_ERR_NO_ERROR - On success. Otherwise see the error code list.
coldchain_get_sensor_info Syntax: Windows public int coldchain_get_sensor_info(ref Sensor_Info information) Description: Get logger sensor internal information. Parameters: information [out] Please refer to Sensor_Internal_Information Structure. Returns: MRM_ERR_NO_ERROR - On success. Otherwise see the error code list.
coldchain_get_sensor_data Syntax: Windows public int coldchain_get_sensor_data(ref Sensor_data OD_data) Description: Get logger sensor record temperature and humidity information. Parameters: OD_data [out] Please refer to Sensor_Internal_data Structure. Returns: MRM_ERR_NO_ERROR - On success. Otherwise see the error code list.
coldchain_get_temperature_avg Syntax: Windows public int coldchain_get_temperature_avg(Sensor_data OD_data, ref double temperature_avg) Description: Get temperature average. Parameters: OD_data [in] Pointer to the node object handle that is the returned by coldchain_get_sensor_data(). temperature_avg [out] Calculation total temperature average. Returns: MRM_ERR_NO_ERROR - On success. Otherwise see the error code list.
coldchain_get_humidity_avg Syntax: Windows public int coldchain_get_humidity_avg(Sensor_data OD_data, ref double humidity_avg) Description: Get humidity average. Parameters: OD_data [in] Pointer to the node object handle that is the returned by coldchain_get_sensor_data(). humidity_avg [out] Calculation total humidity average. Returns: MRM_ERR_NO_ERROR - On success. Otherwise see the error code list.
coldchain_export_humiture_data Syntax: Windows public int coldchain_export_humiture_data(Sensor_data OD_data, string FilePath) Description: Export temperature and humidity data to csv. Parameters: OD_data [in] Pointer to the node object handle that is the returned by coldchain_get_sensor_data(). FilePath [in] Save file location. Returns: MRM_ERR_NO_ERROR - On success. Otherwise see the error code list. Remark: Save file to .csv format.
coldchain_export_falling_data Syntax: Windows public int coldchain_export_falling_data(Sensor_data OD_data, string FilePath) Description: Export falling data to csv. Parameters: OD_data [in] Pointer to the node object handle that is the returned by coldchain_get_sensor_data(). FilePath [in] Save file location. Returns: MRM_ERR_NO_ERROR - On success. Otherwise see the error code list. Remark: Save file to .csv format.
coldchain_export_alarm_data Syntax: Windows public int coldchain_export_alarm_data(Sensor_data OD_data, string FilePath) Description: Export temperature and humidity alarm data to csv. Parameters: OD_data [in] Pointer to the node object handle that is the returned by coldchain_get_sensor_data(). FilePath [in] Save file location. Returns: MRM_ERR_NO_ERROR - On success. Otherwise see the error code list. Remark: Save file to .csv format.
LoRa Gateway coldchain_gateway_init Syntax: Windows public int coldchain_gateway_init(string COM_Port, int lora_channel, int lora_data_rate) Description: Open the LoRa Gateway through the serial port. Parameters: COM_Port [in] Specifies which Serial Port Path to connect firmware. For example "COM1" lora_channel [in] Set LoRa frequency channel, Value 1 to 5. lora_data_rate [in] Set Data Rate. Value : 0 is Low , 1 is High. Returns: ADVCC_ERR_SUCCESS - On success. Otherwise see the error code list.
coldchain_gateway_deinit Syntax: Windows public int coldchain_gateway_deinit() Description: Close LoRa Gateway the serial port. Parameters: None Returns: ADVCC_ERR_SUCCESS - On success. Otherwise see the error code list.
coldchain_gateway_get_version Syntax: Windows public int coldchain_gateway_get_version(ref Version FirmwareVer) Description: Get the Gateway version of firmware. Parameters: FirmwareVer [out] Please refer to Version Structure. Returns: MRM_ERR_NO_ERROR - On success. Otherwise see the error code list.
coldchain_gateway_start_receive_lora_data Syntax: CallBack Function public delegate void ReceiveLoRaCallBack(Sensor_LoRa_data data); Windows public int coldchain_gateway_start_receive_lora_data(ReceiveLoRaCallBack cb) Description: When the event is triggered, the ReceiveLoRaCallBack() callback of registered handler instance will be triggered. Parameters: cb [in] Pointer to a user defined callback function. data[out] Please refer to Sensor_LoRa_data Structure. Returns: MRM_ERR_NO_ERROR - On success.
coldchain_gateway_stop_receive_lora_data Syntax: Windows public int coldchain_gateway_stop_receive_lora_data() Description: Clear the callback registration of the ReceiveLoRaCallBack. Parameters: None Returns: MRM_ERR_NO_ERROR - On success. Otherwise see the error code list.
coldchain_gateway_added_filter Syntax: Windows public int coldchain_gateway_added_filter(string uid) Description: Designate LoRa uid add whitelist for filter, Only added uid will receive. Parameters: uid[in] Receive LoRa uid. Returns: MRM_ERR_NO_ERROR - On success. Otherwise see the error code list.
coldchain_gateway_remove_filter Syntax: Windows public int coldchain_gateway_remove_filter(string uid) Description: Designate LoRa uid remove whitelist. Parameters: uid[in] Receive LoRa uid. Returns: MRM_ERR_NO_ERROR - On success. Otherwise see the error code list.
coldchain_gateway_reset_filter Syntax: Windows public int coldchain_gateway_reset_filter() Description: Reset whitelist. Parameters: None Returns: MRM_ERR_NO_ERROR - On success. Otherwise see the error code list.
coldchain_gateway_get_filter Syntax: Windows public int coldchain_gateway_get_filter(ref string[] uid) Description: Get all the uid values in the whitelist. Parameters: uid [out] Get setting uid list.. Returns: MRM_ERR_NO_ERROR - On success. Otherwise see the error code list.
Error Code List • (0) ADVCC_ERR_SUCCESS - On success.
• (40000003) ADVCC_ERR_GATEWAY_RECEIVE_NOT_ACTIVE • (40000004) ADVCC_ERR_GATEWAY_FILTER_ALREADY_SETTING • (40000005) ADVCC_ERR_GATEWAY_FILTER_NOT_SETTING
www.advantech.com Please verify specifications before quoting. This guide is intended for reference purposes only. All product specifications are subject to change without notice. No part of this publication may be reproduced in any form or by any means, electronic, photocopying, recording or otherwise, without prior written permission of the publisher. All brand and product names are trademarks or registered trademarks of their respective companies. © Advantech Co., Ltd.
