tweterm.py

This program incorporates the pyftdi (https://github.com/eblot/pyftdi) library sample script pyterm.py with a firmware write script for TWELITE. It has the following features

• Writing firmware for TWELITE (TWELITE R/MONOSTICK)

• Checking the behaviour via the serial port

This script requires the Python3 interpreter to run on OS X. It is intended for users who are familiar with the command line environment and the Python interpreter.

In order to make this script work on Linux, you will need the equivalent packages (libusb-dev, pyserial, pyftdi). It is intended for people who are familiar with the command line environment and the Python interpreter.

• reference environment：Ubuntu 16.04 (i386 32bit), Python3.5.2 / Ubuntu 18.04 (x86-64 64bit), Python 3.6.5

Warranty and license

Anything in this package that is not specifically mentioned in the license is governed by the Mono Wireless Software License Agreement.

This software is not officially supported by Mono Wireless Inc. Please note that we may not be able to answer your enquiries. Please understand beforehand.

In response to reports of defects or other problems, Mono Wireless Inc. does not promise to fix or improve the product.

It may not work in all cases, depending on the package you have installed and your environment.

# Copyright (C) 2017 Mono Wireless Inc. All Rights Reserved.
# Released under MW-SLA-*J,*E (MONO WIRELESS SOFTWARE LICENSE
# AGREEMENT)

System requirements and required packages

• Mac OS X or Linux

• python3.5 or later

• libusb

• pyserial

• pyftdi

reference environment

We have developed and tested the software in the following environments. However, we do not guarantee that it will work in these environments.

environment
Mac OS X 10.11.6, Python3.5.1 (2018/05)
Ubuntu 18.04, Python3.6.7 (2018/05)
Mac OS X 10.14.2, Python3.7.2 (2019/01)

installation

packages

macOS

Below is an example of installing all new packages using Homebrew.

Homebrew

install Homebrew.

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Python3

$ brew install python3

libusb

$ brew install libusb

pyserial

$ pip3 install pyserial

pyftdi

$ pip3 install pyftdi

Linux

Please check your distribution's package installation instructions. You will need the following packages.

• python3.5 or later (In many cases, it has been introduced)

• libusb-dev

• pyserial

• pyftdi

example for package installation.

$ sudo apt-get install libusb-dev
$ sudo apt-get install python3-pip
$ pip3 install pyserial
$ pip3 install pyftdi

実行

The folder where the TWELITE SDK was installed is described as ${TWELITESDK}.

The script can be found below.

${TWELITESDK}/Tools/tweterm/tweterm.py

Gives the script permission to run.

$ chmod +x ${TWELITESDK}/Tools/tweterm/tweterm.py

If necessary, add it to the PATH environment variable.

$ PATH=${TWELITESDK}/Tools/tweterm:$PATH

Usage

Unload USB driver

Unload the driver as libusb conflicts with the OS driver.

macOS

Unloads FTDI-related drivers.

$ sudo kextunload -b com.apple.driver.AppleUSBFTDI

Linux

No need to unload the driver.

If you get an error, try unloading the driver.

$ sudo rmmod ftdi_sio
$ sudo rmmod usbserial

Command parameters

parameter	remark
-p ftdi:///? or -p	Enumerates the list of devices.
-p [device name]	Specify the device.
	ftdi:///1 When no other device is available.
	ftdi://::MW19ZZUB/1 Designation by serial number.
-b [baud]	Specify the baud rate
	-b 115200 115200bps
-F [firmware bin file name]	Program the specified firmware.
	-F App_Twelite.bin Program a file named App_Twelite.bin.
--no-color	Suppresses colour output of text.
--no-term	It only programs the firmware and does not open the terminal.

keyboard operation

Typing Ctrl+C will bring up a control prompt, which allows you to perform some special operations. Otherwise, the input string will be sent directly to the TWELITE radio module.

Key sequence	Remark
Ctrl+C Ctrl+C	quit the terminal
Ctrl+C Ctrl+R または Ctrl+C r	Reset TWELITE microcontroller.
Ctrl+C Ctrl+I または Ctrl+C i	Enter the + + + command to enter interactive mode. Only available with firmware that supports interactive mode.
Ctrl+C A	Start interpreting the format: for the output from the TWELITE wireless microcontroller and for the key input, the ascii format (like :00112233X) is interpreted.
Ctrl+C B	Starts interpreting the format; binary format is interpreted for the output from the TWELITE microcontroller. Key input is interpreted in ASCII format.
Ctrl+C N	Stops interpreting the format.

During format interpretation, only messages from TWELITE that have been interpreted will be displayed, and keyboard input will be echoed back, but will be sent to TWELITE when the ASCII format has been completed.

[Execution example]

In the example, line breaks are inserted as appropriate.

If you get an error, it may be a problem with the permissions on the serial port, run it with root privileges (e.g. sudo).

Make sure your device is listed first.

$ tweterm.py -p ftdi:///?
Available interfaces:
  ftdi://ftdi:232:MW19ZZUB/1   (MONOSTICK)
  Please specify the USB device

Program the firmware and start the terminal

The following example writes App_UART (UART communication app) and checks the boot message.

$ tweterm.py -p ftdi://ftdi:232:MW19ZZUB/1 -b 115200 -F ../App_Uart_Master_RED_L1101_V1-2-15.bin 
*** TWE Wrting firmware ... ../App_Uart_Master_RED_L1101_V1-2-15.bin
MODEL: TWEModel.TWELite
SER: 102eebd

 file info: 0f 03 000b
erasing sect #0..#1..#2..
0%..10%..20%..30%..40%..50%..60%..70%..80%..90%..done - 10.24 kb/s
Entering minicom mode

!INF TWE UART APP V1-02-15, SID=0x8102EEBD, LID=0x78
8102EEBD:0> 

Typing Ctrl+C will bring up a control prompt

*** r:reset i:+++ A:ASCFMT B:BINFMT x:exit>

Then enter i. You are now in interactive mode

*** r:reset i:+++ A:ASCFMT B:BINFMT x:exit>[+ + +]
--- CONFIG/TWE UART APP V1-02-15/SID=0x8102eebd/LID=0x00 -E ---
 a: set Application ID (0x67720103) 
 i: set Device ID (121=0x79) 
... ＜省略＞ 

If you type + + + three times as usual operation, you will get the same result.

Example of format interpretation: Set App_UART to binary format

In interactive mode, type m B Enter S in that order.

--- CONFIG/TWE UART APP V1-02-15/SID=0x8102eebd/LID=0x00 -E ---
 a: set Application ID (0x67720103) 
 i: set Device ID (121=0x79) 
 c: set Channels (18) 
 x: set RF Conf (3) 
 r: set Role (0x0) 
 l: set Layer (0x1) 
 b: set UART baud (38400) 
 B: set UART option (8N1) 
 m: set UART mode (B)*
 h: set handle name [sadkasldja] 
 C: set crypt mode (0) 
 o: set option bits (0x00000000) 
---
 S: save Configuration
 R: reset to Defaults
 
!INF Write config Success
!INF RESET SYSTEM...

Examples of format interpretation

In the following example, App_UART does input and output in binary format. Input Ctrl+C B.

*** r:reset i:+++ A:ASCFMT B:BINFMT x:exit>
[FMT: console ASCII, serial BINARY]

In this state, input and output is in format. Keyboard input is interpreted as ASCII (input is converted to binary and sent to the TWELITE) and messages from the TWELITE as binary.

Here is an example of receiving a message from TWELITE. The easiest way to do this is to reset the TWELITE. Type Ctrl+C r.

*** r:reset i:+++ A:ASCFMT B:BINFMT x:exit>[RESET TWE]
[dbf1677201030001020f008102eebd0000]

The output [dbf...] is the message from TWELITE, which is actually 0xdb 0xf1 0x67... which is actually a binary sequence.

Conversely, to send a message to TWELITE, enter it in ASCII format. Type :7800112233AABBCCDDX. This sends the data with a payload of 0x7800112233AABBCCDD to TWELITE in binary format. Immediately afterwards, [dba18001] is returned as the response.

:7800112233AABBCCDDX[dba18001]

Quitting

Input Ctrl+C Ctrl+C to quit terminal.

*** r:reset i:+++ A:ASCFMT B:BINFMT x:exit>[
[EXIT]
Bye.