Rev 1.0 2016-09-02 1
Table of Contents Table of Contents... 2 Table of figures... 3 1. Revision history... 4 2. Introduction... 4 3. Included Material... 4 4. Requirements... 5 5. BitPipe Development Kit Description... 6 6. Quick Start... 8 6.1. Install PC driver for the FTDI communication cable... 8 6.2. Install BitPipe Cellular Test Tool Software... 8 6.3. BitPipe Cellular Modem Installation... 8 6.4. SIM card insertion... 9 6.5. FTDI communication cable... 10 6.6. Antenna... 10 6.7. Power In / Boot-up... 10 6.8. Start BitPipe Cellular Modem Test Tool Software... 11 6.9. PC to Modem Connection... 12 6.10. Cellular Network Connection Status... 13 6.11. Configure your APN... 15 6.12. Download Your First Web Page using TCP Connection... 15 6.13. Send and Receive your First TCP Data... 17 6.14. SMS Tab... 19 6.15. Debug Tab... 22 7. Autonomous Mode Demo... 24 2
Table of figures Figure 1: BitPipe Development Kit... 5 Figure 2: ADPT-BP-DEMO sections... 6 Figure 3: ADPT-BP-BOB headers... 7 Figure 4: Modem fastened with the screw... 9 Figure 5: SIM card orientation... 9 Figure 6: SIM card insertion... 10 Figure 7: BitPipe Cellular Test Tool... 11 Figure 8: Communication port selection... 12 Figure 9: Communication successfully established... 12 Figure 10: Power-On Radio... 13 Figure 11: DC-DC Warning... 13 Figure 12: Radio status... 13 Figure 13: Mobile Information tab... 14 Figure 14: Configure APN... 15 Figure 15: Establish socket connection... 16 Figure 16: Received data... 16 Figure 17: TCP echo... 18 Figure 18: SMS Tab... 20 Figure 19: SMS reception... 21 Figure 20: Debug tab... 23 Figure 21: Autonomous Mode Configuration... 24 Figure 22: BitPipe Dev-Kit Demo Website... 25 3
1. Revision history Revision Date Comments 0.9 2016-07-19 Pre release 1.0 2016-09-02 First release 2. Introduction The BitPipe Development Kit provides an easy way to test the BitPipe cellular modules. The BitPipe Cellular Test Tool is designed to help to test all the functionalities of the modem and perform cellular communication within minutes. 3. Included Material The development kit contains the following items: 1x BitPipe Cellular modem 1x ADPT-BP-DEMO (demo board) 1x ADPT-BP-BOB (break out board) 1x Penta Band Antenna* 1x UFL to SMA antenna adapter* 1x AC-DC Wall Mount Adapter 9V-12W 1x USB to Serial communication cable 3.3V (TTL-232R-3V3-2MM) 1x Screw * Depending on the BitPipe flavor you ordered, the content of the development kit may vary. The latest version of the BitPipe Cellular Test Tool is available for download on the Briowireless website. Please visit the download section for all the technical documentation required for development. 4
Figure 1: BitPipe Development Kit 4. Requirements In order to use the development kit, the user will need to provide the following: An activated Micro SIM (3FF) A PC with Windows 7 or higher 5
5. BitPipe Development Kit Description In the Development Kit, there are two base boards available to connect the BitPipe. Each one are described below. The demo board is mainly used to do a quick demonstration of the BitPipe autonomous mode. The Figure 2 identifies different sections of the board. Each section are listed below 1. Thumbwheel (GPIO3) 2. BitPipe Connector 3. LEDs (GPIO0, GPIO1, GPIO2) 4. AUTONOMOUS switch (SW1) 5. FTDI Connector 6. Power ON (D1) Refer to section 7 for more information about how to use the autonomous mode. 1 2 3 4 5 6 Figure 2: ADPT-BP-DEMO sections 6
The break o board is used to provide an easy connectivity to the BitPipe Cellular modem connector when prototyping. Two 100 mils headers are available on the bottom side, spaced to fit most breadboards. Figure 3 provides the pinout of those headers. Please refer to the BitPipe Cellular modem datasheet before connecting to any circuitry. Figure 3: ADPT-BP-BOB headers 7
6. Quick Start This quick start guide is a simple walkthrough to help with the first cellular data transmission using the BitPipe Cellular modem. 6.1. Install PC driver for the FTDI communication cable Download and install the cable manufacturer (FTDI) driver on your PC. Driver can be found (here). Plug the FTDI communication cable (TTL-232R-3V3-2MM) in one of the PC USB port, and confirm that the cable is correctly detected. Under Device Manager (in Windows), you should see a USB Serial Port device under Ports (COM & LPT): 6.2. Install BitPipe Cellular Test Tool Software Download and unzip, in a folder of your choice, the latest version of BitPipe Cellular Test Tool. The latest version can be found (here). 6.3. BitPipe Cellular Modem Installation Insert the modem in the demo board identified as ADPT-BP-DEMO in the Figure 2 and use the provided screw to securely fasten the modem on the dev-kit. The switch (SW1) should be at the position OFF to 8
enable the Modem mode. Please refer to the BitPipe Cellular modem datasheet for more information about Operating modes. Figure 4: Modem fastened with the screw 6.4. SIM card insertion Insert the SIM card in the slot in the front of the modem. A click should be heard when it is fully inserted. The SIM card holder is a Push-in / Push-out type. Figure 5: SIM card orientation 9
Correct Incorrect Figure 6: SIM card insertion 6.5. FTDI communication cable Connect the communication cable (TTL-232R-3V3-2MM) in the demo board identified as FTDI Connector in the Figure 2. 6.6. Antenna Install the provided antenna in the modem SMA or UFL connector. 6.7. Power In / Boot-up Connect the Wall adaptor in the power outlet and the barrel plug extremity in the demo board lowerright connector in the Figure 2. The modem will boot automatically and the green LED identified as Power ON (D1 designator) in the Figure 2 will light-up when the modem is ready to establish the communication with the PC. 10
6.8. Start BitPipe Cellular Modem Test Tool Software Launch the BP-C-TestTool.exe application (previously unzipped in the section 6.2 of this document). Figure 7: BitPipe Cellular Test Tool 11
6.9. PC to Modem Connection The first step in using the modem is to establish the communication between the PC and the modem. Once the Modem is correctly connected and powered: 1- Click on the BitPipe dropdown menu 2- Click on Connect to BitPipe 3- Select the correct serial port to communicate in the pop-up window a. The default UART speed is 115200 bps. 4- Then click OK to start the communication Figure 8: Communication port selection As displayed in the Figure 9, the status indicator located in the lower right corner of the test tool indicates the port number on which the communication has been established. Figure 9: Communication successfully established 12
6.10. Cellular Network Connection Status To allow the BitPipe Cellular modem to establish the registration on the cellular* network, you need to power on the radio. 1- Click on the tab Mobile Information 2- Click on the button Power-On Radio with the DC-DC radio button selected *Before following these procedures, make sure your SIM card has a data plan. Figure 10: Power-On Radio Since you are using the demo board, it is safe to use the DC-DC translator to power the board so you can accept the warning by clicking Yes. Figure 11: DC-DC Warning As displayed in the Figure 12, wait until the radio status is set to Ready Figure 12: Radio status 13
The Mobile Information tab will display the network connection status. Press the Retrieve buttons one by one to update the associated information. Figure 13: Mobile Information tab 14
6.11. Configure your APN Select the Mobile Information tab and enter your cellular carrier APN information required to send data over its network. This information must be provided by the cellular carrier. Login and password could be optional, depending on the cellular carrier. Then click on Configure Figure 14: Configure APN 6.12. Download Your First Web Page using TCP Connection It s possible to download web pages content by sending a HTTP GET request to a web server. 1- Click on the IP Socket tab 2- Write down the hostname in the Hostname (or IP address) field, and port a. For example www.google.com, Port: 80 3- If a connection is already established with another server, click Close connection 4- Click Initiate Connection to open a socket with the server listed in step 2 5- Write the GET request to download a web page a. For example GET / HTTP/1.1 b. Add two carriage return and line feed (Press 2 times on Enter ) 6- Click the Send Payload button 7- The response content will be displayed in the Received Data section 15
The Figure 16 shows the result of the HTTP GET example. Figure 15: Establish socket connection Figure 16: Received data 16
6.13. Send and Receive your First TCP Data This example demonstrates sending and receiving a message from a public TCP echo server on the Internet. Follow these steps: 1- Click on the IP Socket tab 2- Write down the URL in the Hostname (or IP address) field a. For example IP 195.34.89.241, Port 7 3- If a connection is already established with another server click Close connection 4- Click Initiate Connection to establish a TCP connection with the server listed in step 2 5- Enter a text message in field below the Connection Status 6- Click the Send Payload button 7- The response content will be displayed in the Received Data section The Figure 17 shows the result of the TCP echo server example. You can use your own TCP echo server, or if you don t have one, contact us, we can provide you with an access to our TCP Echo server. 17
Figure 17: TCP echo 18
6.14. SMS Tab This example demonstrates sending and receiving a text message (SMS) from/to a cellphone. Follow these steps: 1- In the MSISDN (Phone Number) field, enter the receiver phone number 2- Select the message encoding 3- Click Setup SMS 4- Enter your message in the text box below the Setup SMS button 5- Click Send SMS The Figure 18 shows the result of the SMS transmission. 19
Figure 18: SMS Tab 20
6- On the recipient cellphone, write back a message to the Bitpipe 7- Once received, the SMS message will be written in the SMS Reception textbox. The Figure 19 shows the result of the SMS reception. Figure 19: SMS reception 21
6.15. Debug Tab The Debug tab is aimed at software/firmware integrators, to help them at the UART communication layer. The BitPipe Serial API is used to communicate with the BitPipe over UART. This tab can be seen as a tool to deepen understanding of communication, and facilitate troubleshooting of issues that may be encountered while integrating the BitPipe. This tab allows you to see the actual message generation, transmission of a request and reception of a reply. An example is provided to retrieve the BitPipe firmware version. Here are the steps: 1- In the Input Command Data field, enter the following hexadecimal string: 11 01 00 2- Click Generate Message a. The message is displayed in the Generated Message field. 3- Click Send Message a. The message is sent to the BitPipe, a reply should be immediately visible in the Received Reply box below. As can be seen in Figure 20, the binary data exchanged is displayed in hexadecimal notation, with the character representation on the left. This allows easy analysis of message data exchanged. The Message CRC will be computed by the Test Tool, so there s no need to enter it in the Input Command Data. Refer to the BitPipe Serial API documentation for more information. The latest version can be found (here) in the Download section. 22
Figure 20: Debug tab 23
7. Autonomous Mode Demo The Autonomous Mode allows the BitPipe to be used without a controlling Host (or application). You can read more about this operating mode in the BitPipe Cellular modem datasheet. To easily demonstrate how this mode works, a demo back-end has been set up on Briowireless servers. You may configure your BitPipe to use this back-end to test and see how simple it is to configure, monitor and control the BitPipe s IOs. To set-up your BitPipe for this demo, it must be configured with Briowireless server information. This includes setting the MQTT Hostname, MQTT Port and Keep-Alive Interval. For your convenience, this information can easily be configured by following these steps: 1- Open the Autonomous Mode Configuration dialog from the Tools menu 2- In the popped-up dialog, click on Load Demo Config The configuration for the demo is auto-filled in the form. 3- Click on Configure : Figure 21: Autonomous Mode Configuration 24
4- Unplug the power supply from the BitPipe 5- Turn the AUTONOMOUS switch to ON, designated by SW1 on the demo board 6- Plug back the power supply in the BitPipe After step 6, the BitPipe should automatically start the Radio and establish a connection to the demo servers. This requires that the APN is configured, and an activated SIM with a data plan is inserted in the BitPipe. See section 6.4 and 6.11. From the Autonomous Mode Configuration dialog, press Open Web Page to remotely control the BitPipe LEDs intensity, and monitor the actual value of the thumbwheel (potentiometer), in real-time. Note: Changing the Autonomous Mode configuration requires a power-cycling of the BitPipe. Figure 22: BitPipe Dev-Kit Demo Website 25