TWELITE PAL/CUE/ARIA Script

• 1: How to Use
• 2: Source Files
• 2.1: PAL_Script.py
• 2.2: Main_user.py
• 2.3: MNLib
• 2.3.1: apppal.py
• 2.3.2: appbase.py
• 2.3.3: mwSerial.py
• 2.3.4: parseFmt.py parseFmt_*.py

1 - How to Use

Preparing Your PC

1. Extract the downloaded archive to an easy-to-find folder (for example, C:).

2. Download and install Anaconda suitable for your PC environment from the following webpage.
   https://www.anaconda.com/download/
   If you do not want to install Anaconda, refer to “If Not Installing Anaconda”.

3. Open Anaconda Prompt and run the following command to install pyserial. (On Windows, open Anaconda Prompt from the Start menu → Anaconda3.)

   
   pip install pyserial

If Not Installing Anaconda

The installation steps below are an example for Windows OS. Please refer to the documentation of each library and install the necessary software and libraries.

1. Download and install the latest version of Python from the following page.
   https://www.python.org/downloads/
   
   At that time, make sure to check the box surrounded by the frame in the figure below
   or add Python’s installation directory to your PATH.

   

2. Open Command Prompt and enter the following command to install pyserial.

   
   pip install pyserial

Preparing TWELITE PAL

1. Connect SENSE PAL to BLUE PAL/RED PAL.
2. Insert a coin cell battery (CR2032) into the battery holder of BLUE PAL/RED PAL.

Preparing MONOSTICK

1. Rewrite the MONOSTICK application (App_PAL-Parent-xxx-MONOSTICK.bin).
2. Reset MONOSTICK or reconnect it to the USB port.

Running the Script

If the COM port of MONOSTICK is COM6, run the following command in Anaconda Prompt to output data as shown below. (It cannot be started if Teraterm is connected.)

cd C:\PAL_Script
python PAL_Script.py -t COM6
*** MONOWIRELESS App_PAL_Viewer 1.1.0 ***
  *** Open COM6 ***
ArriveTime : 2021/03/05 09:43:28.880
LogicalID : 1
EndDeviceSID : 10B6465
RouterSID : No Relay
LQI : 180 (-35.50 [dBm])
…

To exit the script, press Ctrl+C in Anaconda Prompt.

Script Arguments

You can use the following arguments when running the script.

Argument: -h

Function: Display a list of command line arguments
Example: python PAL_Script.py -h

Argument: -t

Function: Specify the port name used by MONOSTICK
Setting: MONOSTICK port name
Default: COM3 on Windows, /dev/ttyUSB0 on Linux, etc.
Example: python PAL_Script.py -t COM6

Argument: -b

Function: Specify the baud rate of the port used by MONOSTICK
Setting: MONOSTICK baud rate
Default: 115200
Example: python PAL_Script.py -t COM6 -b 115200

Argument: -l

Function: Output log in CSV format
Example: python PAL_Script.py -t COM6 -l
Note: A CSV file will be generated in the same directory.
The file name will be AppPAL_SerialNumber_PAL_YYYYMMDD.csv

The CSV file columns are explained in the table below.

2 - Source Files

Operating Environment

Operation has been confirmed in the following environment.

• Windows 10 Build 1809
  • Python 3.6.4
    • pyserial 3.4

2.1 - PAL_Script.py

How to Read Data

The example below checks whether data has been received from MONOSTICK and, if so, passes it to the Main() function.

from apppal import AppPAL

...

def mainloop(PAL):
	# Check if the user-defined Main function can be imported.
	try:
		from Main_user import Main
	except:
		mainflag = False
	else:
		mainflag = True

	# Check whether data is available
	if PAL.ReadSensorData():
		if mainflag:
			# If Main was imported, pass the PAL object to Main()
			Main(PAL)
		else:
			# If Main was not imported, display the data on the console.
			PAL.ShowSensorData()

...

if __name__ == '__main__':
...

	try:
		PAL = AppPAL(port=options.target, baud=options.baud, tout=0.05, sformat=options.format, autolog=bEnableLog, err=bEnableErrMsg, stdinput=options.stdinp, Logfilename=options.file)
	except:
		print("Cannot open \"AppPAL\" class...")
		exit(1)

	while True:
		try:
			mainloop(PAL)
		except KeyboardInterrupt:
			break

	del PAL

First, create an AppPAL object. Since serial port settings are configured at instantiation, pass them as arguments.

PPAL = AppPAL(port=options.target, baud=options.baud, tout=0.05, sformat=options.format, autolog=bEnableLog, err=bEnableErrMsg, stdinput=options.stdinp, Logfilename=options.file)

Next, in the mainloop(), call ReadSensorData() to check whether serial data has arrived. If it returns True, pass the interpreted result to Main().

def mainloop(PAL):
	# Check if the user-defined Main function can be imported.
	try:
		from Main_user import Main
	except:
		mainflag = False
	else:
		mainflag = True

	# Check whether data is available
	if PAL.ReadSensorData():
		if mainflag:
			# If Main was imported, pass the PAL object to Main()
			Main(PAL)
		else:
			# If Main was not imported, display the data on the console.
			PAL.ShowSensorData()

For details on the dictionary structure received, refer to this section.

2.2 - Main_user.py

# Write the desired processing inside this function
def Main(PAL=None):
	# Check if the passed variable is an instance of AppPAL
	if isinstance(PAL, AppPAL):
		sns_data = PAL.GetDataDict()

		# Reception time
		print('Receive Time: ', end='')
		if isinstance(sns_data['ArriveTime'], datetime.datetime):
			print(sns_data['ArriveTime'].strftime('%Y/%m/%d %H:%M:%S') + '.%03d'%(sns_data['ArriveTime'].microsecond/1000))
		else:
			print(sns_data['ArriveTime'])

		# Logical Device ID
		print('Logical ID: 0x%02X'%sns_data['LogicalID'])
		# Serial Number
		print('Serial ID: 0x' + sns_data['EndDeviceSID'])
		# Power Voltage
		print('Power: %d mV' % sns_data['Power'])

		# Check the sensor name
		sname  = PAL.GetSensorName()

		# If the sensor name is PAL, output model name such as PAL/ARIA/CUE
		if sname == 'PAL':
			pid = PAL.GetPALName()
			print('Sensor: ' + pid )
		else:
			print('Sensor: ' + sname )

		# Analog sensor mode (App_Tag)
		if sname == 'Analog':
			print('ADC1: %d mV'%sns_data['ADC1'])
			print('ADC2: %d mV'%sns_data['ADC2'])
		else:
			# Hall IC
			if 'HALLIC' in sns_data.keys():
				print('HALLIC: %d'%sns_data['HALLIC'])

			# Temperature
			if 'Temperature' in sns_data.keys():
				print('Temperature: %.02f degC'%sns_data['Temperature'])

			# Humidity
			if 'Humidity' in sns_data.keys():
				print('Humidity: %.02f %%'%sns_data['Humidity'])

			# Illuminance
			if 'Illuminance' in sns_data.keys():
				print('Illuminance: %f lux'%sns_data['Illuminance'])

			# Pressure
			if 'Pressure' in sns_data.keys():
				print('Pressure: %f hPa'%sns_data['Pressure'])

			# Acceleration
			if 'AccelerationX' in sns_data.keys():
				print('X: ', end='')
				print(sns_data['AccelerationX'])
				print('Y: ', end='')
				print(sns_data['AccelerationY'])
				print('Z: ', end='')
				print(sns_data['AccelerationZ'])

			# Gyroscope
			if 'Roll' in sns_data.keys():
				print('Roll: ', end='')
				print(sns_data['Roll'])
				print('Pitch: ', end='')
				print(sns_data['Pitch'])
				print('Yaw: ', end='')
				print(sns_data['Yaw'])

			# Color sensor
			if 'Red' in sns_data.keys():
				print('Red: ', end='')
				print(sns_data['Red'])
				print('Green: ', end='')
				print(sns_data['Green'])
				print('Blue: ', end='')
				print(sns_data['Blue'])
				print('IR: ', end='')
				print(sns_data['IR'])


		print()

2.3 - MNLib

2.3.1 - apppal.py

Class AppPAL

This class inherits from AppBase, interprets the received payload, converts it into usable data, and stores it in a dictionary object.

Parameters for Definition

Parameters with default values are optional.

ReadSensorData()

This method reads the payload and interprets it according to the TWELITE PAL parent format.

Parameters

None

Return Value

If data is successfully read: True If data could not be read: False

The keys stored in the dictionary object are as follows.

OutputCSV()

Outputs the dictionary object to a CSV file.

Parameters

None

Return Value

None

2.3.2 - appbase.py

class AppBase

This code provides a base class implementing common functions required for all TWELITE APPS. It includes operations such as opening and closing the serial port, reading serial data, and writing to log files.
The derived class apppal.py interprets the received byte sequence, stores the data in a dictionary object, and returns it to the main function.

GetDataDict()

Interprets the payload and returns a dictionary object containing the data.

Parameters

None

Return Value

2.3.3 - mwSerial.py

Class MWSerial

This class manages serial port operations such as reading and writing.

Parameters for Definition

Initial values are set and do not need to be specified.

SerialSelect

Searches for serial ports connected to the PC and prompts the user to select one.

If only one port is available, it is automatically selected.
If no ports are found, None is returned.
If a port name is passed as an argument, that port will be used.

Parameters

Return Value

None

2.3.4 - parseFmt.py parseFmt_*.py

class FmtBase

The base class for format parsers, defining common procedures. Subclasses such as FmtAscii (ASCII format) and FmtBinary (binary format) inherit from this.

Format parsers are designed for serial input. For ASCII format, interpretation is done per line; for binary format, it is done byte by byte. Once the input sequence satisfies the defined header, footer, and checksum, the parsing is considered complete and the content excluding the header and footer (the payload) is stored.

process(c)

Interprets the input string. After interpretation, if is_complete() returns true, the interpretation succeeded and the payload can be obtained via get_payload(). Since subsequent process() calls may invalidate the payload, it should be retrieved immediately after completion.

To interpret another sequence, call process() again.

Parameters

Return Value

None

is_comp()

Called after process() to indicate whether format interpretation is complete. If true, the payload can be retrieved using get_payload() or get_payload_in_str().

Parameters

None

Return Value

get_payload()

Returns the payload.

Parameters

None

Return Value

Returns the payload portion excluding header and footer as a list of bytes.

reinit()

Explicitly resets the internal state.

Parameters

None

Return Value

None

Other methods

Several internal-use methods are defined. Please refer to the source code for details.

Code Examples

Sequence-level Interpretation

Interprets a str sequence a and stores the payload in pay. For example, pay will contain [ 0x78, 0x80, 0x01, ... , 0x00 ].

import parseFmt_Ascii

fmta=parseFmt_Ascii.FmtAscii()
a = ':7880010F0F0380030002800200DF'
pay = []

fmta.process(a)

if fmta.is_comp():
    pay = fmta.get_payload()

Byte-by-byte Interpretation

For binary sequence b, parsing is performed one byte at a time using the process() method. When the end byte 0x04 is input, parsing completes and the payload is stored in pay.

import parseFmt_Binary

fmtb=parseFmt_Binary.FmtBinary()
b = [0xA5, 0x5A, 0x80, 0x05, 0x78, 0x00, 0x11, 0x22, 0x33, 0x78, 0x04]
pay = []

for x in b:
  fmtb.process(x)

  if fmtb.is_comp():
    pay = fmtb.get_payload()
    break