TapNPass User Manual
The TapNPass provides radio access to systems with a serial connector, thus removing the need for cables. It adapts easily to existing systems that were not designed for wireless communication. The TapNPass provides RF access via a mobile device to monitor or configure existing electronic systems and is available in 2 versions:
This documentation covers details that are not covered in the Getting started.
Nomad and Fix versions
There are 2 TapNPass versions for different use-cases.
|Can be used with different systems||Dedicated to one system|
|Equipped with rechargeable batteries for a long autonomy and designed to be easily moved from one system to another||Equipped with a power supply connector and designed to be installed close to a specific machine|
In this documentation, if a paragraph applies to one version only, the version is explicitly indicated.
- TapNPass supports NFC and BLE communication channels
- These channels can be combined, which provides additional adavantages for consuption and security
- The document RF host protocols (NFC, BLE, WiFI...) provides full information on RF channels (consumption, range, data transfert rate, ...)
- See also Technologies/Security for a deeper insight on NFC pairing feature
Monitoring your target system from your mobile device
The TapNPass is not a simple hardware product, but part of a global solution. It embeds a TapNLink module that can be easily configured in IoTize Studio to convert your mobile device into a powerful Human Machine Interface for your system:
- If your system features a Modbus interface, you can generate a simple Web app in minutes, using the Web app Generator included in IoTize Studio configuration software.
- Generic apps and examples are provided for other cases. APIs allow to developp native application to meet any a specific application.
- Refer to the Mobile Development for a full description of available methods and related tools.
Configure / Use
The TapNPass is a configurable product. Once configured for specific equipment, it can be dedicated to a very specific usage. Therefore, we can consider 2 types of users:
The (end) user of a pre-configured TapNPass needs only to know how to:
- connect the cables
- manage the battery (for the Nomad version)
- use the Monitoring app
The 'developer' who wants to customize a TapNPass to:
- rapidly develop Apps that monitor "Modbus" systems, using a native Modbus RTU driver (master)
- get a simple "transparent" and secure to link your mobile device to the target system (sharing a same protocol)
- set the various options, such as:
- general communication parameters: baud rate, parity, ...
- communication mode: Modbus access or transparent mode,
- security mechanisms
List of materials
This list describes the standard delivery.
The outer carton contains:
- A TapNPass Nomad case with its electronic boards
- A mini-USB cable for only serial communication
- Two RJ45 <=> DB9 cables for serial communication: one for RS-232 and one (with a blue identifier) for RS-485
- A micro-USB cable that can be used for two purposes: either to recharge the Li-Ion batteries, or to communicate with a machine equipped with a compatible connector.
- Two rechargeable Li-Ion batteries. Read the Safety chapter in the appendix.
To install the batteries, turn the TapNPass over, press on the center of the case, then slide and lift to remove the back cover.
Insert the provided rechargeable Li-Ion batteries in the battery compartment. They must be in the same direction that is engraved into the plastic and shown in the picture below:
If battery replacement is necessary, replace both batteries. Use only 800mAh AA-size (14500) Li-Ion protected rechargeable batteries:
- Nominal voltage: 3.7V
- Dimensions: 14 x 51mm
- Max charge current: 1.5C
- Max discharge current: 2C
DO NOT USE other types of rechargeable or non-rechargeable AA size batteries. TapNPass does not work with such batteries.
- 14500 batteries are generally 50mm long, but many are over 51mm.
- We recommend to use the branded "Soshine" batteries that fit with the characteristics above.
Connect TapNPass's micro-USB port to a USB port of a PC (or a charger for mobile) and fully charge the batteries before use.
- Typical charging time is 1 hour.
- The battery charge indicator (green) LED turns off when the battery is fully charged.
- Note that the battery charge indicator LED will blink red if the battery is under 20% of full capacity.
- When the battery capacity is under 10% of full capacity, the power will automatically turn off to prevent damage to batteries.
The contents are similar to the Nomad, with the same cables but the following differences:
- Some screws are provided to allow the TapNPass to be fixed
- Fix TapNPass does not have a battery compartment, nor batteries...
- A male connector is provided to connect an external power supply (voltage in the range of [10V-30V]). It is next to the USB-A connector. The two-contact female connector (Molex 039530-0002) must be removed to insert the wires from the power source.
We recommend connecting a power source of 5W (12V/400mA or 24V/200mA). Use 2.5mm² wires to provide a power source of 12V or 24V (up to 30V). Note that the polarity does not matter, since the voltage input is equipped with a bridge rectifier.
The TapNPass itself is a low power device (typically 200 mW), but overall consumption depends on the connected devices. If you connect a USB device on the USB-A port, it could consume up to 2.5W (5V - 500mA). The following consumption was measured on a TapNPass Nomad with a 5V source:
- RS-232: 35mA
- RS-485: 45mA
- USB: 110mA (with a FTDI or CP210x connected cable).
The RJ-45 connector on the top of the casing is dedicated to pure serial connections: RS-232 and RS-485 signals are mixed as described in the appendices (note that the RJ45 is NOT an Internet connection).
The USB-A connector on the bottom of the casing is a "host USB connector".
Software, Apps and APIs
- IoTize Studio reference manual details how to download IoTize Studio configuration software
- The free apps (Tap Mananger, IoTize Terminal) can be found in Google Play Store
- Note that the preconfigured app attached to your TapNPass, generally IoTize Terminal, is automatically accessed when you "tap" your TapNPass with your mobile device
- IoTize Terminal allows to configure dynamically some communication settings (baud rate,...)
- it is also a good way to test communication.
- After configuration, a new app reference (AAR for Android) can be written in the NFC tag of your TapNPass (so as to launch your own app).
The TapNPass Nomad requires that the batteries are charged before the device is powered up. It is recommended to set the cable connection (for communication) before powering up the device.
Just press the push button. The LEDs all light-up for two seconds before you can use your TapNPass. Note: TapNPass Nomad automatically switches off after 10 minutes of inactivity. This duration can be changed in the configuration.
A long press (more than 2 seconds) of the push button stops and switches off the power of the device. More precisely, after a couple of seconds the 3 LEDs light-up, then the power switches off when the button is released.
This action can be disabled in the Fix version, and the device can be powered off either by software (from an authorized mobile device) or when the power connector is disconnected.
Note: the power must be ON to use the data logging feature of TapNPass.
The TapNPass features 3 LEDs above the push button. They display (from top to bottom):
- Communication activity (Blue/Orange)
- Battery state (Green/Red)
- Power status (Green)
The power LED blinks in a "ramping up" mode when the device is powered.
The battery LED shows (Nomad only):
- Green: battery is recharging (Nomad).
- Red low frequency blinking: battery charge < 10%. In this situation, the power LED is turned off.
The communication LED shows:
- Orange: incoming data transfer.
- Blue: outgoing data transfer.
Particular combinations indicate particular events or states:
- AVAILABLE: blue LED 'ramps up' to indicate TapNPass is NOT connected to a mobile (but is available for a connection).
- CONNECTED: blue and orange LEDs blink alternately (@1Hz during 2s) when the connection is established.
- OVERCURRENT: red battery LED blinking (@ 1Hz) indicates the current consumed by an external device connected to the USB port was higher than 500mA, so the USB connection was switched off to avoid damage.
- IDENTIFICATION: an API can send a message to the connected TapNPass to make all the LEDs blink synchronously for 5 seconds (@5Hz). This state is useful to identify a specific device when several are installed in the same area.
Serial communication ports
The TapNPass provides:
- 2 communication channels on the RJ45 connector
- Two RJ45-to-DB9 cables are provided to use the RS-232 and RS-485 channels
- They differ by their pinning and length:
- RS-232 is 40cm long
- RS-485 is 50cm long with a blue ring identifier around the cable
- One communication channel on the USB host port
The RS-232 port is available on the RJ45 connector using its standard RJ45-to-DB9 cable. Note that both RJ45 and DB9 pinouts comply with the standard RS232-MODBUS specification.
- Baudrates from 1200bps to 300kbps are supported
- Frame: length (7/8/bit) and parity (none, odd, even), acknowledge (CTS/RTS) are selectable.
The resistor must be switched on when TapNPass is placed at the end of a long chain.
- The same baudrates and frames as RS-232 are supported.
The RS-485 port is available on the RJ45 connector using its RJ45-to-DB9 cable (with blue ring identifier).
- When communicating through the RS-485 channel, it is possible to add a termination resistor of 120 ohms to reduce noise. A micro-switch is accessible on the Nomad version after removing the battery cover:
The switch can be turned by inserting a small screw driver in the hole reserved for clipping the back cover into the frame:
The electronic board must be removed from the plastic case in order to modifiy the switch position.
The TapNPass features a HOST USB-A connector (USB 2.0). This connector can supply up to 500mA to a connected device. It can drive different types of USB-to-UART converters:
- FT232x (from FTDI Chip)
- CP210x (from Silabs)
- Any USB communications device class (CDC) compliant device.
Serial port configuration in IoTize Studio
Open the menu 'IoTized Application / Tap' and view the pane Link Target <=> Tap underneath. The serial port options are as follows:
- 'RS-485', 'RS-232', 'USB', 'AUTO' :
- if AUTO, USB mode is set if a USB device is detected, otherwise RS-232 is set.
- 'RS-485', 'RS-232', 'USB', 'AUTO' :
These settings can also be changed dynamically:
- from your own app, which includes this API
- from IoTize Terminal app
- note that in both cases, these modifications are lost after your TapNPass is powered off
Connect to a mobile device
There are several ways to connect a TapNPass to a mobile device, IoTize Terminal is the simplest. Refer to the document Mobile Development for mobile development methods.
Start with IoTize Terminal App
- TapNPass is pre-configured to launch IoTize Terminal, a simple app that allows to enter a string to be transmitted to the target and to display the answer.
- The IoTize Terminal app also allows to dynamically change the default settings such as the baudrate, or the parity. This app is also to test serial communications.
- Other apps can also be attached to your TapNPass: you have to configure the AAR stored in the NFC tag of your TapNPass so that the desired app is installed/launched automatically when you tap your TapNPass.
Install IoTize Terminal
Enable NFC on your mobile device, and locate its NFC antenna.
Power up your TapNPass, and 'tap' the NFC logo (at the center of the circle engraved on the top cover of the casing) with your mobile near its NFC antenna.
After tapping, your mobile opens the specific page on Google Play (or Apple store) to download the application (if not already installed).
If your mobile does not support NFC communication, you can dowload IoTize Terminal app from Google Play or Apple Store (search for IoTize Terminal...).
Communicate with IoTize Terminal
You can launch the app by either:
- Tapping again with the NFC,
- Running the app directly from the list of installed apps.
Character strings (ASCII or hex) can be entered and transmitted from this application. The incoming flow is also displayed:
Communication settings are accessed from the main menu (button with three horizontal bars in the top right).
To clear the content of the terminal window, click the button in the top right.
In IoTize Studio, you can define the way TapNPass communicates with the target system:
- Expand the IoTized Application/Target
- View the related settings in the Target pane underneath
- Type of Target: IoTize Studio can handle several types of Tap. Select 'System (TapNPass)' for TapNPass.
- SVD/XML pathname
- this is a path to an XML file containing the address and size of ModBus registers
- this feature will be available in future versions, and the syntax will be detailed then
You can also modify these communication options dynamically
- from your custom mobile app, using the relevant librairies and APIs
- from the IoTize Terminal example.
Target Communication Modes
TapNPass has 2 main communication modes: Modbus or Serial Standard. The mode is selected in Target protocol settings.
- TapNPass and the target communicate using Modbus RTU communication protocol.
- TapNPass is a Modbus Master and the target a Modbus Slave.
- TapNPass can access 'modbus registers' which can be attached to 'bundles'.
- access can be restricted (read and/or write) for each combination profile / bundle (see Access Control
- IoTize Studio built-in Web app generator can automatically generate HTML pages, providing access to these 'modbus registers'
- data logging applies to "modbus registers' attached to a bundle
- the APIs handling Variables also apply to 'Modbus registers'.
- Slave Address: If the Modbus communication is between one Master (TapNPass) and one Slave(Target system), you can provide here the Slave unit address to be used as the default address for commands.
- Timeout: Response timeout (unit = 1/10 s).
- TapNPass becomes a simple means of serial stream between the target system and the mobile application.
- TapNPass could be considered as a 'lockable secure cable'.
- Protocol layers should be handled at the application level.
- Baudrate: communication speed in bps. Select Custom to specify your desired value greater than 300bps and less than 300kbps.
- Parity: check bit for error detection.
- Length: the number of data bits.
- Stop bits: end of characters number of bits.
- Handshake: synchronization handshaking.
The settings Identification with LEDs and Enable LEDs can be ignored in this version.
- The access control configuration in TapNPass ensures that users only access authorized target resources.
- Access to various TapNPass functions is equally important from a security standpoint, Profile-based access control in TapNPass helps achieve this goal.
- Refer to the section Technologies/Security for a full description of the underlying mechanisms and concepts: bundles, resources, profiles, users
- The information which follows focus on options dedicated to TapNPass.
The different types of resources that could be protected through the access control system are:
- for ModBus you can access target Modbus registers
- you define manually the address and the symbol, as in the ModBus example of the Getting Started session
- in future versions, it will be possible to define these ModBus registers (address, size) from an XML file
- 'Features' (or 'protected Features')
- Modbus Direct: you can access target Modbus communication (using any standard 'ModBus' commands)
- Serial Direct: you can access Serial communication Both types of resource can be attached to Bundles (groups of resources) and be handled in the ACL mechanisms
- A Bundle is a collection of resources.
- Bundles make it easy to grant access to the various resources or limit access when it is needed.
- You can do this in IoTize Studio, by attaching (one or several) Profile(s) to a Bundle.
Refer to these pages for details about Access Control:
- Technologies/Security for the detailed underlying mechanisms.
- Serial and Modbus examples in the TapNPass Getting started for configuration examples.
Connectors and cables specifications
For wired connections, TapNPass features a standard USB type A female connector and a RJ45 8P8C modular jack:
- The USB connector complies with USB Full-Speed specification.
- The RJ45 jack is used for both RS-485 and RS-232. It does NOT support ethernet, but only RS-232 and RS-485 signals.
Three cables are provided to adapt the signals from this jack:
- male RJ45 plug to DB9 male for RS232.
- male RJ45 plug to DB9 male for RS485. A small blue spiral is attached to this cable to differ.
- male RJ45 plug to RJ45 jack to invert RS485 signals to comply with the 2W-modbus specification (supplied by May 2019).
The following table describes the pinout of these different cables:
|Signal||RJ45 on-board jack||RS-232 DB9 cable||RS-485 DB9 cable||RJ45 female=>jack cable|
For the first production (version V3.1 of the main board) signals D0 and D1 have been inverted in regard to the modbus specification. Indeed we have on the RJ45 connector D0 on pin 4 and D1 on pin 5. By May 1st 2019, a "male<=>female" RJ45 cable crossing these 2 signals(4&5) is provided to match with the modbus specification. This "female-male" RJ45 crossed cable allows to adapt the connector to comply with 2W-Modbus specification.
Li-Ion Rechargeable Batteries
- Li-Ion batteries may cause fire if misused, mishandled, dropped or damaged.
- Keep Li-Ion batteries away from children.
- Take care of the orientation of the batteries when inserting them into their compartment.
- Only charge batteries inside the provided TapNPass product, using the micro-USB port for charging as intended. Do not charge the batteries on other chargers or by any other means.
- During charging, observe constant observation to monitor the charging process and do not leave the product in contact with a flammable surface, material or substance.
- Do not use old and new batteries at the same time, or batteries with different brand names. Only use the provided batteries, or the reference 800mAh-AA (14500) Soshine li-ion protected rechargeable batteries if replacements are required.
- If a battery starts to balloon, swell up, smoke or overheat, stop charging immediately. Disconnect the battery and observe it in a safe place for approximately 15 minutes. Damage to the battery may cause leaks, and the reaction with air may cause the chemicals to ignite, resulting in fire.
- Never drop the batteries. In the event of a direct impact on a battery, remove the battery for observation. Place it in a safe open area away from any combustible material for approximately 15 minutes.
Battery storage & transportation
- Store the batteries at room temperature (18°-25°C) for best results.
- Do not expose batteries to direct sunlight, or heat source, for extended periods.
- When transporting or temporarily storing the product in a vehicle, avoid extreme temperatues (< -5°C, > 65°C). Storing batteries at > 75°C for > 2 hours may cause damage / fire.
- For information about transporting Li-Ion batteries, refer to https://www.iata.org.
Charge the battery every 2 months even if the product has not been used.
- This product (electrical and electronic equipment) must not be placed in municipal waste. Check local regulations for disposal of electronic products.
- DO NOT throw the battery in municipal waste.
TapNPass casing can easily be customized by replacing the stickers. Please contact IoTize for more information.