Related Manuals for InPlay NanoBeacon IN100
Summary of Contents for InPlay NanoBeacon IN100
- Page 1 InPlay NanoBeacon™ IN100 Config Tool User Guide Specifications and information are subject to change without notice.
-
Page 2: About Documentation
Control Number IN1IDOC-SW-IN100-EN-V1_06 External User Revision V1.06 This document applies to the following products: Document number Applicable Products Document Status IN100-D1-R-RC1I Mass production IN100-D1-R-YC1I Mass production IN100-Q1-R-RC1I Mass production IN100-Q1-R-YC1I Mass production IN100 IN100-Q1-R-YC1F Mass production IN100-W10-R-SC1I Mass production www.inplay-tech.com... -
Page 3: Table Of Contents
Advanced Settings .................... 46 XO Settings ....................... 47 2.10 RF Test ......................49 Programming OTP Memory ..............51 Before you start ....................51 Verification....................... 53 OTP memory programming ................54 Revision History .................. 56 Reference ................... 56 Disclaimer ................... 56 www.inplay-tech.com... - Page 4 Figure 31 : Enable of GPIO input states as trigger ............. 31 Figure 32 : Power switch control ..................32 Figure 33 : ADC configuration tab .................. 33 Figure 34 : ADC channel configuration ................34 Figure 35 : Unit mapping setting ..................35 www.inplay-tech.com...
- Page 5 Figure 56 : Programming with NanoBeacon™ config tool ..........52 Figure 57 : UART communication status report dialog ............. 52 Figure 58 : RAM run mode status report ................53 Figure 59 : Burning in progress ..................54 Figure 60 : Programming progress complete ..............55 www.inplay-tech.com...
- Page 6 IN100C0 Config Tool User Guide List of Tables Table 1 : MGPIO mapping to analog input channels ............32 www.inplay-tech.com...
-
Page 7: Introduction
Instead, the IN100 is configured through a PC GUI tool, the InPlay NanoBeacon Config Tool. The NanoBeacon Config Tool provided by InPlay allows the user to easily configure and test various advertising modes and payloads for the IN100. For testing the device, the configuration can be run from RAM and will execute its settings as long as the IN100 device is being powered. -
Page 8: Things You Will Need
• Device capable of scanning for Bluetooth packets (phone, tablet, etc.) • [optional] CR1220 battery Software (freely available from InPlay website at https://inplay-tech.com/in100) • NanoBeacon config tool software (Windows/Linux/Mac OS) – for configuring and testing the tag • NanoBeacon BLE Scanner App (Android and iOS) or other Bluetooth Scan app (several freely available on Google Play Store and Apple App Store) –... -
Page 9: How To Configure And Use The Nanobeacon
Please refer to the “InPlay IN100 NanoBeacon Scanner User Guide” about installing and using InPlay’s custom NanoBeacon BLE Scanner application for Android and iOS. The “Run in RAM”... -
Page 10: Nanobeacon Config Tool
Figure 3 : Tag board powered by a coin-cell battery 2. NanoBeacon Config Tool InPlay NanoBeacon config tool is a PC GUI (Graphical User Interface) tool for configuring and testing the IN100. The PC tool allows for flexible configuration of the IN100’s peripherals, advertising data payloads, and advertising parameters according to the use case requirements. -
Page 11: Advertising Sets Configuration
“Edit” button to access the configuration settings for that advertising set. These settings include the advertising parameters. The user can use the “View Raw Data” button to review the advertising raw data that the user has configured. www.inplay-tech.com... -
Page 12: Figure 5 : Advertising Sets Configuration Overview
The "QR Code" button will provide a QR code which contains the advertising address information for the user's mobile application to easily identify and parse data from advertisers. The InPlay Nanobeacon BLE Scanner App can scan this QR code to filter for the beacons that match the user’s settings. -
Page 13: Advertising Data Format
“User Defined Data” section. Adv Data AD Structure 1 AD Structure M Length (1 byte) AD Type ( 1 byte) AD Data (Length- 1 bytes) Figure 7 : Advertising data format www.inplay-tech.com... -
Page 14: Figure 8 : Customer-Defined Advertising Data Format
Manufacturer Specific Data: This is an AD type defined by Bluetooth SIG [2]. The first two data octets shall contain a company identifier from the Assigned Numbers [3] . The default manufacture ID is 0x0505 which is the Assigned Number for InPlay Inc by Bluetooth SIG. For the AD data configuration, please refer to Section 2.1.3. -
Page 15: Advertising Data Configuration
ADC CH1: Digital sample of the external analog input to the mixed signal GPIO pin 5 (MGPIO5). 2 bytes. • ADC CH2: Digital sample of the external analog input to the mixed signal GPIO pin 6 (MGPIO6). 2 bytes. www.inplay-tech.com... -
Page 16: Figure 10 : On-Chip Temperature And Vcc Unit Setting
Below are the steps to entry the advertising data: 1) Enter one data segment: • If it is predefined data, user can directly type in the data entry box. Note: Only hexadecimal data is supported where 2 characters represent one byte. www.inplay-tech.com... -
Page 17: Advertising Data Encryption And Authentication
To enable encryption and authentication, in the device, the user needs to decide the following inputs to the AES-EAX engine for each advertising set in the config tool: • A single 16-byte key used for both encryption and authentication. www.inplay-tech.com... -
Page 18: Figure 12 : Advertising Data Encryption And Authentication
If the user does not need authentication, then the user can select not to present the tag in the advertising data. Figure 12 : Advertising data encryption and authentication To enable encryption and authentication for the specific data field in each advertising set, the user needs to check the “Encrypt” box as shown in Figure 13. www.inplay-tech.com... -
Page 19: Figure 13 : Encryption Enabling
Figure 14 : Selection of key and nonce for AES-EAX for each advertising set The configuration for the three encryption keys are under “Global Settings” as shown in Figure 15. The input box of the corresponding key needs to be filled with hexadecimal numbers. www.inplay-tech.com... -
Page 20: Figure 15 : Configuration Of Encryption Keys
If the receivers know the salt, it does not need to be advertised. If the salt is a random number or static random number, we need to include the salt in the advertising data as a plain text, which is shown in www.inplay-tech.com... -
Page 21: Figure 16 : Including The Aes-Eax Salt In The Advertising Data
Please be noted, the “Big Endian” box must be checked for the corresponding item selected as the nonce counter. If the receivers know the nonce counter, then it does not need to be included in the advertising data. For example, if we select to use a predefined fixed number. www.inplay-tech.com... -
Page 22: Figure 17 : Including The Nonce Counter In The Advertising Data: Time Stamp 1
For example, the device does not support the case where Data 1 and Data 3 are encrypted, and Data 2 are not encrypted as shown in Figure 19. The device only supports the encryption of a continuous data block as illustrated in Figure www.inplay-tech.com... -
Page 23: Figure 19 : Encryption Of A Non-Continuous Data Block
“Data” entry box, as shown in Figure 21. Figure 21 : Encrypt the predefined data Encryption of extended data item To encrypt an extended data item, check “Encrypt” box when appending that item to the advertising data, as shown in Figure 22. www.inplay-tech.com... -
Page 24: Figure 22 : Encrypt An Extend Data Item
1 byte up to 8 bytes. If only encryption is needed, and no authentication is needed, then we do not need to add the tag in the advertising data. Figure 23 : Including a tag in the advertising data www.inplay-tech.com... -
Page 25: Advertising Raw Data Review
2 to 20 which equivalent to from 16us to 200us. • Advertising Random Delay: Introduces a random delay on top of the nominal advertising interval. The default value is between 0 to 10 ms but goes up to between 0 and 160 ms. www.inplay-tech.com... -
Page 26: Advanced Advertising Parameter Configuration
The configuration tool provides users with the flexibility to go beyond using standard Bluetooth link layer advertising packet formats for their specific application needs. www.inplay-tech.com... -
Page 27: Advertising Mode Configuration
Figure 27. Otherwise, it is automatic generated the config tool. Figure 27 : Advanced advertising parameter settings 2.1.8 Advertising mode configuration The NanoBeacon™ supports two advertising modes: continuous mode and event triggered mode which can be configured using the GUI as shown in Figure 28. www.inplay-tech.com... -
Page 28: Figure 28 : Advertising Mode Selection
(caused by any trigger condition being met). The device will initiate the advertising again based on any subsequent trigger events. • Advertise Indefinitely after 1 trigger: Enables the device to continue advertising indefinitely at each advertising interval after any trigger condition is met. www.inplay-tech.com... -
Page 29: Trigger Source Configuration For Triggered Advertising
This setting determines the interval at which the device will check the value of the sensor inputs. If the trigger condition is met, then the device will start advertising. Figure 29 shows the location of this parameter in the GUI tool. www.inplay-tech.com... -
Page 30: Figure 29 : Sensor Trigger Source And Trigger Check Period Setting
Figure 29 : Sensor trigger source and trigger check period setting The user can use the “Global Trigger Settings” tab to map a senor input source to Triggers 1 through 4 as shown in Figure 30. In that tab, the user can also configure the thresholds. www.inplay-tech.com... -
Page 31: Figure 30 : Sensor Trigger Source And Thresholds
The device assumes the pulse count is an unsigned 16-bit number. • Internal chip temperature: The device integrates an internal temperature sensor and the user can set the threshold based on the desired temperature value. The input value unit can be www.inplay-tech.com... -
Page 32: Analog Channels And Adc Configuration
There are up to 4 analog input channels (part number dependent) available in the device as shown in Table 1. The chip's internal ADC has 11 bits, referenced by internal 0.8V bandgap reference. The ADC can be used to digitize the analog inputs to the mixed signal GPIOs. www.inplay-tech.com... -
Page 33: Configuration
When “Enable” is checked for a certain ADC channel, the digital GPIO function corresponding to the multiplexed pin needs to be turned off, and pull-up and pull-down need to be turned off. This can be done by setting the GPIO to analog (See section 2.5 for details). www.inplay-tech.com... -
Page 34: Figure 33 : Adc Configuration Tab
“Number of Samples to Skip” and “Number of Samples to Average” are adjusted according to the external analog device. By default, the ADC samples the input 18 times, and throws away the first 2 samples. The output is the average of last 16 samples. www.inplay-tech.com... -
Page 35: Figure 34 : Adc Channel Configuration
For example, a temperature sensor outputs 1.4V when the temperature is 100 Celsius degree, and outputs 0.4V when -10 Celsius degree. Additionally, 1 LSB (Least Significant Bit) is used in the advertising data to represent 0.1 degrees Celsius. In that case, the unit www.inplay-tech.com... -
Page 36: Gpio Edge Count
Figure 35 : Unit mapping setting GPIO edge count The device supports counting of rising edges on a selected GPIO, as shown in Figure 36. The rising edge counting can be performed even when the device is in deep-sleep. The count length supported www.inplay-tech.com... -
Page 37: I2C Configuration
Please note that the selected GPIO need to be set as “Input” in the GPIO configuration tab. I2C configuration The NanoBeacon Config Tool provides the user with an easy way to configure the external I2C slave devices through I2C configuration tab window as shown in Figure 38. www.inplay-tech.com... -
Page 38: Figure 38 : I2C Configuration Tab
For example, if the user needs to read 6-bytes every time the IN100 wakes up, this value would be 6. I2C Commands To drive an external I2C slave device, an I2C communication protocol needs to be defined and configured accordingly. The NanoBeacon Config Tool provides the “I2C Commands” input section for this purpose. www.inplay-tech.com... -
Page 39: Figure 39 : In100 States
When the device needs to advertise again, it will perform a warm boot and wakeup before advertising. If the commands are only needed to be executed during cold boot, then only the cold boot box needs to be checked. www.inplay-tech.com... -
Page 40: Figure 40 : I2C Commands Configuration Window
Only the selected read data will be advertised on the data payload. An example is shown in Figure 41Error! Reference source not found.. The offset is 4, and number of bytes is 3. Given these settings, the device will only advertise 3 bytes of I2C read data starting from the address of 0x2304. www.inplay-tech.com... -
Page 41: Gpio Configuration
The read data can be added to the payload with small or big endianness and encryption options. Only the selected read data will be advertised on the data payload. An example is shown in Figure 41Error! Reference source not found.. GPIO configuration The GPIO configuration tab window is shown in Figure 42. www.inplay-tech.com... -
Page 42: Figure 42 : Gpio Configuration Tab
Refer to section 2.1.1.1 for more information on configuring the GPIOs as inputs. To enable GPIO ADV trigger, the corresponding GPIO needs to be set to input. www.inplay-tech.com... -
Page 43: One-Wire Sensor Interface Configuration
“Enable” box. If the external sensor needs dynamic power control, then check the corresponding box according to the application circuit design. The user can also configure the GPIO connected to the one-wire sensor output. The user can adjust the timing parameters in the Timing Control Settings based on the one-wire sensor specification. www.inplay-tech.com... -
Page 44: Square Wave Settings
IN100C0 Config Tool User Guide Figure 44 : One-wire count configuration tab Square wave settings The square wave tab appears as shown in Figure 45. www.inplay-tech.com... -
Page 45: Figure 45: Square Wave Settings
Figure 46. The options range from 16 kHz at maximum and 62 Hz at minimum. The options decrease from 16 kHz by a factor of 2 each step, such as 16 kHz, then 8 kHz, www.inplay-tech.com... -
Page 46: Figure 46: Square Wave Settings With Square Wave Output Type
Lastly, there is a functionality to trigger and disable the square wave output via a triggered advertising set, as shown in Figure 47. This is useful if the square wave output is needed to blink an LED in accordance with an advertising event or other similar uses. www.inplay-tech.com... -
Page 47: Advanced Settings
A special support channel is available through the advanced register settings provided by InPlay support engineers. Always consult the InPlay support team before making any changes in this mode. Changes made here may override settings in other parts of the tool. -
Page 48: Xo Settings
IN100C0 Config Tool User Guide Figure 48 : Advanced mode settings As shown in Figure 48, users can follow the instructions of InPlay engineers to enter the registration command and then add it to the settings box. Then click the OK button to exit. -
Page 49: Figure 49 : Xo Circuit
IN100C0 Config Tool User Guide InPlay Device XO_P XO_N Figure 49 : XO Circuit Figure 50 : XO tab and XO setting configuration www.inplay-tech.com... -
Page 50: Rf Test
XO Settings Disclaimer: In most cases, it is not recommended for the customer to evaluate the XO by themselves. Instead, InPlay provides a list of tested crystals that have been verified by the crystal manufacturer to work with the IN100. Although the XO settings are tunable through the GUI, it is difficult for anyone but the crystal manufacturer to do more specific tests such as an oscillation margin test or testing multiple samples over various temperatures and voltages. -
Page 51: Figure 52 : Rf Test Interface
The user needs to configure the frequency and TX power from pull-down lists. Hardware Settings The user can enter the desired Tx output power in the Tx Power (dBm) box. User can also enter the XO Load Capacitance value to minimize the transmit channel frequency offset. www.inplay-tech.com... -
Page 52: Programming Otp Memory
Port drop-down box. Baud rate Baud uses the default 115200. Then click the Connect button to establish a connection to the device. As shown in the figure below, whether the connection is successful or failed, there will be a pop-up box, as shown in Figure www.inplay-tech.com... -
Page 53: Figure 56 : Programming With Nanobeacon™ Config Tool
Configure the advertising sets and peripherals. • Verify if the configuration meets the application needs. • Press the “Burn/Program” button to program the OTP memory. Figure 56 : Programming with NanoBeacon™ config tool Figure 57 : UART communication status report dialog www.inplay-tech.com... -
Page 54: Verification
NanoBeacon™ config tool to write the configuration data into RAM. Then use the Bluetooth advertising scanning software to scan the data advertised by the NanoBeacon™ to confirm whether the advertising data is correct or not. Figure 58 : RAM run mode status report www.inplay-tech.com... -
Page 55: Otp Memory Programming
NanoBeacon™ Config tool to perform OTP memory burn. There will be a progress bar during the burning process, as shown in Figure 59, and there will be a pop-up box for successful burning report or a pop-up box for failed burning report just in case. www.inplay-tech.com... -
Page 56: Figure 60 : Programming Progress Complete
Figure 60 : Programming progress complete After burning, remove the OTP memory programmer board, install the battery onto the NanoBeacon development board and the board shall operate normally. Note: Once burned, the device cannot be erased and burned again. www.inplay-tech.com... -
Page 57: Revision History
(or inability to use) this document, or from your use of (or failure to use) the information on this document. InPlay Inc and its company logo are registered trademarks of InPlay Inc with its registered office at 1 Technology Drive, STE J728, Irvine, CA, USA 92618. www.inplay-tech.com...
Need help?
Do you have a question about the NanoBeacon IN100 and is the answer not in the manual?
Questions and answers