2013 Microchip Technology Inc. DS00001529A-page 1 Machine-to-Machine (M2M) technology allows remote
devices to communicate with each other or with a cen- tral server over one or more communications networks.
M2M is commonly used to monitor or control devices deployed at remote locations without the need of human assistance. M2M is used in a wide variety of applications, such as utility meters, asset tracking, robotics, supply chain management and many others.
The Microchip M2M Development Platform for CDMA uses the Verizon Wireless cellular network to communicate with a cloud-based server. Cellular- based technology is ideal for M2M, as it can provide a common communication pathway for remote and mobile devices to exchange information.
The Microchip M2M platform provides a variety of sensors and communications technologies to interface with remote devices. The platform sends and receives data to and from a cloud-based server through the CDMA cellular network. The server is accessed by the user through a web portal that can be customized to an individual user's needs. Through the web portal, the user can display, analyze and download data collected by the M2M platform, and send commands to the platform to control remote devices.
THE M2M ECOSYSTEM
The Microchip M2M Development Platform for CDMA makes it easy to learn and develop M2M solutions that communicate over the Verizon Wireless network. The platform is one part of an integrated, cloud-based M2M ecosystem. The platform communicates with the ecosystem through the Verizon Wireless CDMA cellular network. Data is sent and received through a Verizon cloud-based M2M data management center.
Data received by Verizon is forwarded to a cloud-based data server where it is stored in a database. The contents of the database are accessible through any web browser that has access to the Internet. Through this web portal, users can monitor and control any number of M2M devices.
FIGURE 1: PIC32-BASED M2M ECOSYSTEM (HTML5/VERIZON WIRELESS)
Twisthink Web Server Verizon Wireless
Internet
Developer GUI Verizon
Advanced M2M Cellular Tower
M2M Platform
Hosted Private Network (HPN)
Microchip M2M Development Platform for CDMA
DS00001529A-page 2 2013 Microchip Technology Inc.
FEATURE OVERVIEW
The Microchip M2M Development Platform for CDMA provides a Verizon Wireless-certified “out-of-the-box”
M2M solution, or can be used as an extensible platform for custom applications. The platform provides a variety of sensors and interfaces to allow the designer to tailor the solution for a specific application.
The M2M platform RF software and hardware are certified under the Verizon Wireless Open Development Initiative (ODI) certification specifications, and have been approved for use on the Verizon Wireless network. The application software communicates to the network using the Verizon Device Client Framework (DCF). The DCF software implementation is owned by Verizon, and is provided with the platform as a binary module. Documentation for the DCF API is available from the Microchip M2M web site. Refer to “Verizon M2M Developer Program” for more information.
The DCF binary module and source code for the application software is available for download from the Microchip web site at www.microchip.com/m2m.
Figure 2 provides a hardware block diagram of the Microchip M2M Development Platform for CDMA.
Certifications
The Microchip M2M Development Platform for CDMA (P/N: DM320017) is a development/evaluation tool designed to be used for research and development in a laboratory environment to enable customers to experiment with software to develop their target end- products. The DM320017 is certified as FCC Part 15 compliant for use as a finished product in the United States and Canada.
The DM320017 carries the CE label for compliance with EU Directive 2011/65/EU (RoHS2). It should not be placed into the EU market (e.g., sale, loan, lease, gift, etc.) without confirmation of inapplicability of or alternatively, compliance to, EU EMC Directive 2004/
108/EC as supported by the European Commission’s Guide for the EMC Directive 2004/108/EC (8th February 2010).
See Appendix D: “RF Exposure Information” for FCC and RSS certification information.
Programming Support
FIRMWARE UPDATES
The M2M platform provides a Microchip In-Circuit System Programming (ICSP) debugger/programmer interface (J9) for physically connecting a Microchip MPLAB® REAL ICE™ In-Circuit Emulator or MPLAB ICD 3 In-Circuit Debugger to update the firmware in the host PIC32 microcontroller. See Appendix B:
“Referenced Sources” for information on obtaining these development tools.
Power Supply
INPUT
The M2M platform is powered by a 12V DC, 500 mA power supply, which is included with the platform.
OUTPUT
12V DC input power and 3.3V DC regulated I/O power are available on the General Purpose I/O header to power external devices.
Operating Temperature
All functions of the M2M platform operate between the temperature range of -20ºC and +85°C (batteries may not meet this requirement).
ochip Technology Inc.DS00001529A-page 3
AN1 529
Power Supply
3.8V Step Down
Regulator
Novatel HS3001 CDMA FCC ID: MIVCNN0301 Connectors
Debug Header Power Adapter
Input (6V-24V)
I/O Headers (2 x 10-pin)
UART USB On-The-Go
micro-B USB
ICSP™
Pins
User Interface Power LEDs
Cellular Signal LEDs 3.3V LDO
3.3V
Programmable I/O
micro-USB 5V
Step Down Regulator
Cell Power
UART RS-232
Level Shifter RS232 (DB9)
Cellular Activity LEDs
Status LEDs
GPIO PWM SPI
Analog Digital UART
CAN CAN Transceiver
CAN (DB9)
802.15.4 Transceiver
Front-End Module Balun
SPI
8 Mb Flash Memory
SPI
512 KB Flash 128 KB Data Memory
80 MHz Core Processor
20 MHz Crystal Microcontroller PIC32MX795F512L
GPIO
Dual-band Cellular Antenna
Filter 5V DC
Output
Ethernet Ethernet PHY RJ-45
ADC
Light Sensor
Accelerometer Temperature
Sensor
I2C™
SD Card SPI
Slot Antenna
Filter
Coax Coax UART
GPS u-blox
MAX-6Q LNA/SW
Filter
Coax GPS Antenna
20 MHz 1 MHz
Switching
2.25 MHz Switching
Cell Power
20 MHz
25 MHz
DS00001529A-page 4 2013 Microchip Technology Inc.
HARDWARE DESCRIPTION
M2M Development Board
The top assembly of the board includes these key features, as indicated in Figure 3:
1. Multi-band antenna (E1).
2. GPS module (U4).
3. micro-USB connector (J8).
4. Microchip PIC32MX795F512L microcontroller (U8).
5. MPLAB REAL ICE in-circuit emulator programmer port (J9).
6. Ethernet 802.3 RJ-45 connector (J7).
7. Standard micro-USB connector (J3).
8. RS-232 DB9 connector (J11).
9. LED 4 (green) (D12).
10. General purpose header 1 of 2 dual row, .100 CTC, 10-pin connector (TB1).
11. General purpose header 2 of 2 dual row, .100 CTC, 10-pin connector (TB2).
12. LED 3 (dual red and green) (D15).
13. Dual binary switch 6 (SW6).
14. Dual binary switch 5 (SW5).
15. LED 2 (red) (D14).
16. Dual binary switch 4 (SW4).
17. LED 1 (yellow) (D13).
18. Dual binary switch 3 (SW3).
19. Light sensor (U18).
20. Barrel type power adapter, 6-12V, 0.5 amp (J12).
21. Switch 2 – diagnostic mode button (SW2).
22. Switch 1 – reset button (SW1).
23. Triple axis accelerometer (U7).
24. Microchip 2.4 GHz transceiver (U2).
25. Microchip temperature sensor (U14).
FIGURE 3: M2M DEVELOPMENT BOARD COMPONENTS
20 19
10 11
4 2
1
3
5
6 7
8 9
12
13 14 15
16 17
18 22
21
23
24
25
2013 Microchip Technology Inc. DS00001529A-page 5
General Purpose I/O Header
The General Purpose I/O Header (see Figure 4) provides two ADC connections to the external header, four general purpose digital I/O connections, one SPI connection, and one UART connection. There is a single power output that supplies 100 mA of current at 3.3V DC and there is one ground connection to the circuit board. In addition, the processor provides one PWM output on the external header.
FIGURE 4: GENERAL PURPOSE I/O (GPIO) HEADER
TABLE 1: GPIO PIN DESCRIPTIONS
8 7 6 5 4 3 2 1 16 15 14 13 12 11 10 9
Pin ID Signal Description
1 — I/O Power
2 U2TX External TX 485A
3 U2RX External RX 485B
4 SCK2 (see SW4 in Table 4) External Serial Clock
5 SDI2 (see SW4 in Table 4) External MISO
6 SDO2 (see SW3 in Table 4) External MOSI
7 Digital I/O or power out (see SW3 in Table 4) External GPIO or 12V Out
8 Ground Signal Ground
9 Digital I/O(1,3) External GPIO 1
10 Digital I/O(1,4) External GPIO 2
11 Digital I/O(1,3) External GPIO 3
12 Digital I/O(1) External GPIO 4
13 CTS(2) Clear-to-Send
14 RTS(2) Request-to-Send
15 AN8 Analog Input 1
16 AN9 Analog Input 2
Note 1: This signal is routed through an ST2149 bidirectional level shifter.
2: Due to pin allocation limitations, CTS and RTS must be implemented in software. If hardware flow control is not required, these pins can be used as additional GPIO.
3: This signal may be configured as an Output Compare for PWM generation.
4: This signal may be configured as a Change Notification input.
DS00001529A-page 6 2013 Microchip Technology Inc.
Figure 5 shows the UART2 signal logic flow based on the settings of switch 5 and switch 6, as described in the Communications Truth Table (see Table 5).
FIGURE 5: TRUTH TABLE DIAGRAM
MCU
232
485
Pass-Through
DB9
TB1 TX
TX RX TX
TX RX
RX
U2TX R
DIN1
SW5
ROUT1
U2RX D
A
B EXT_TX
EXT_RX
MCU
232
485
Pass-through
DB9
TB1 TX
TX RX TX
TX RX
RX
U2TX R
DIN1
ROUT1
U2RX D
A
B EXT_TX
EXT_RX
MCU
232
485
Pass-through
DB9
TB1 TX
TX RX TX
TX RX
RX
U2TX R
DIN1
ROUT1
U2RX D
A
B EXT_TX
EXT_RX A=1
B=1
A = 0
B = 1 SW6
A = 0
B = 0
A = 0
B = 0
A = 1
B = 0
A = 1
B = 1 SW5
SW6
SW5
SW6 Indirectly Connected
Intended Connection
2013 Microchip Technology Inc. DS00001529A-page 7 Figure 6 shows the right side of the platform and the
locations of the serial, RJ-45 Ethernet, and USB connectors.
FIGURE 6: SERIAL, RJ-45 ETHERNET, AND USB CONNECTORS
Figure 7 shows the power adapter and microSD card slot, and General Purpose I/O header.
FIGURE 7: POWER ADAPTER, SD CARD SLOT, AND EXTERNAL CONNECTIONS
DS00001529A-page 8 2013 Microchip Technology Inc.
User Interface
LED INDICATORS
The platform has four LED indicators. LEDs 1, 2, and 3 (D13, D14, and D15) are controlled through software.
LED4 (D12) is controlled by the cell module and is not available to the software.
TABLE 2: LED INDICATORS
PUSH BUTTONS
The platform features two push buttons that are mounted on the board. The operation of the push buttons is described in Table 3.
TABLE 3: PUSH BUTTONS
TABLE 4: DIP SWITCHES
TABLE 5: COMMUNICATIONS TRUTH TABLE
Name ID Description
LED 1 D13 Single color yellow LED.
LED 2 D14 Single color red LED.
LED 3 D15 Dual color LED (red and green).
LED 4 D12 Single color green LED.
Name ID Description
Button 1 SW1 Push button used to reset the PIC32 microcontroller.
Button 2 SW2 Push this button on power-up to force the M2M platform into Test mode (see Appendix E:
“Board Layout and Sche- matics”).
ID Description
SW3 SW3A is used in combination with SW4 (see SW4 for further information).
SW3B is used to select whether GPIO or 12V out is enabled on pin 7 of TB1.
SW4 Pole A of SW3 and poles A and B of SW4 are used together to select whether Ether- net or the SPI2 module is available at TB1.
SW5 SW5 used in combination with SW6 (see SW6 for further information).
SW6 SW6 is used in combination with SW5 to select the RS-232/RS-485 options (see Table 5).
Note: Due to pin limitations, the PIC32 microcontroller can be configured to enable either the Ethernet module or the SPI2 module, but not both at the same time.
SW5 SW6
Communications Path
A B A B
0 0 0 0 Micro Pass-through (External Connection)
0 0 0 1
0 0 1 0
0 0 1 1
0 1 0 0
0 1 0 1
0 1 1 0
0 1 1 1
1 0 0 0
1 0 0 1
1 0 1 0
1 0 1 1 Micro RS-485 (External Connection)
1 1 0 0
1 1 0 1 Micro RS-232 (DB9)
1 1 1 0
1 1 1 1
Legend: = Required
= Should be set to avoid collision
2013 Microchip Technology Inc. DS00001529A-page 9
M2M DEVELOPMENT PLATFORM FEATURES
PIC32 Microcontroller
The Microchip PIC32MX795F512L microcontroller contains a 32-bit, 80 MHz processor, 512 KB of Flash memory, and 128 KB of RAM.
Device Memory
microSD SLOT (J15)
This slot accepts a standard microSD card. The SD card interface communicates with the host processor through the SPI.
To insert the microSD card, push it into the slot until it locks in place. To remove it, push the card in and it will be released.
FLASH MEMORY
The platform has an on-board 8 Megabit SPI Flash memory device, the SST25VF080B from Microchip, which is used to store data.
General Purpose Interface
The General Purpose I/O header consists of two termi- nal blocks (TB1 and TB2) that provide access to vari- ous peripheral interfaces on the PIC32 microcontroller.
The interfaces supported are UART (directly or through an RS-485 transceiver), SPI2, GPIO, and analog input.
See Table 1 for the General Purpose I/O header pin assignments.
SPI
The M2M platform provides an SPI communication interface through the general purpose header. The host processor supports either master or slave roles on the SPI bus.
DIGITAL I/O
The M2M platform provides access for up to seven digital I/O pins through the General Purpose I/O header. The digital I/O pins are software configurable as either inputs or outputs.
The digital I/O pins are routed through a bidirectional level shifter. The level shifter can be enabled or disabled by software.
ANALOG INPUT
The General Purpose I/O header provides two analog inputs (EXT_AN1 and EXT_AN2) capable of measur- ing signals between 0V and 3.3 V with 10-bit analog-to- digital resolution.
PWM OUTPUT
EXTGPIO1 and EXTGPIO3 can be configured as GPIO or Output Compare modules 5 and 4, respec- tively. The Output Compare modules can be used to generate a single pulse or a series of pulses in response to time-base events. A common use of an Output Compare module is to generate a PWM signal.
Communication Devices
CDMA RADIO
The CDMA radio is the HS3001 3G-CDMA Modem from Novatel Wireless. The PIC32 microcontroller communicates to the modem through a serial UART.
GPS RECEIVER
The GPS receiver is the MAX-6Q-0 GSP from u- blox. The PIC32 microcontroller communicates to the GPS receiver through I2C.
WIRELESS NETWORKING
The M2M platform contains a Microchip MRF24J40 IEEE 802.15.4 2.4 GHz radio, which supports the ZigBee® and MiWi™ protocols. The demonstration software includes the Microchip MiWi stack, which is disabled in the default configuration.
Note: Refer to Appendix B: “Referenced Sources” for obtaining additional information on the products described in this section.
Note: The microSD slot is on the bottom of the board, so when inserting the microSD card, it must be “upside down” with the contacts facing up.
Note: Due to pin limitations, the PIC32 micro- controller can be configured to enable either the Ethernet module or the SPI2 module, but not both at the same time.
Note: The analog inputs are buffered through a Microchip MCP6232 dual Op amp, with 118 Ohm pull-down resistors on the Op amp inputs. The pull-down resistors are used to convert current to voltage for sensors that provide a proportional current output signal.
DS00001529A-page 10 2013 Microchip Technology Inc.
ETHERNET
The PIC32 microcontroller has an on-chip Ethernet controller, which communicates to an Ethernet network through an external DP83848 PHY from Texas Instruments. The interface is a standard RJ-45 connector. The controller supports 10/100 data rates.
UNIVERSAL SERIAL BUS
The M2M platform has two USB connectors, one on the exterior of the enclosure, and one on the board.
The exterior connector is a standard micro-B receptacle. When attached to a host through this connector, the platform appears as a Mass Storage Device.
The micro-B receptacle on the board may be used to update the firmware of the cell module; however, it is generally not needed.
SERIAL INTERFACES
The M2M platform supports RS-232 and CAN proto- cols through the DB9 connector (J11). Since the two protocols share pins on the connector, only one can be used at a time.
The pinout of J11 is as follows:
• Pin 1: No connect
• Pin 2: TX
• Pin 3: RX
• Pin 4: No connect
• Pin 5: Ground
• Pin 6: No connect
• Pin 7: CTS
• Pin 8: RTS
• Pin 9: Ground
On-Board Sensors
TEMPERATURE
The M2M platform includes an on-board MCP9800 temperature sensor from Microchip. The MCP9800 is interfaced to the PIC32 through I2C.
LIGHT
The M2M platform includes a light-to-voltage optical sensor (available from Taos P/N: TSL12T) that responds to the surrounding light level. The sensor produces an analog voltage between 0V and 3V proportional to the light intensity on the sensor.
ACCELEROMETER
The M2M platform includes an accelerometer (available from Analog Devices P/N: ADXL345BCCZ- RLTR), which is capable of measuring acceleration in three axes. The update rate is configurable by soft- ware. The accelerometer is able to measure accelera- tions between 0g and 8g with a 10-bit resolution and capable of supplying a sample rate of 200 Hz. It can be configured to provide the host processor with a wake- up signal when the acceleration exceeds a preprogrammed limit.
Note: Although the M2M platform supports wired Ethernet, the initial software release does not.
Note: The CAN transceiver (U21) is not popu- lated in the default board configuration.
SeeAppendix E: “Board Layout and Schematics” for part number and discrete component details.
2013 Microchip Technology Inc. DS00001529A-page 11
GETTING STARTED
To start using your Microchip M2M Development Platform, you must first purchase a data plan from Verizon Wireless.
Register Your M2M Development platform
From the Twisthink web page (www.twistm2m.com), click New Account and enter the MEID of the platform (printed on the outside of the enclosure). You will be taken to the Twist M2M store where you can select the data plan that best fits your needs (see Figure 8).
Within one to two business days after you enter your information and complete the purchase, an e-mail with your account details will be sent to the e-mail address used during account creation. This e-mail confirms the activation of your M2M platform.
Obtaining the Device’s MEID Number
The Mobile Equipment Identifier (MEID) is printed on a sticker, which is located either on the side or on the bot- tom of the platform and is also output to the serial port upon power-up. To obtain the MEID from the serial port, do the following:
1. Attach one end of a standard serial cable to the DB9 RS-232 connector of your M2M platform (see Figure 6) and the other end to a serial port on a computer running a terminal emulation program.
2. Configure your terminal emulation program to operate at 115200 baud, No Parity, No Flow Control, 8 bits per character and 1 Stop bit.
3. Connect a power cable to the DC power adapter located on the side of the unit (see Figure 7).
4. Once power is applied, the platform begins trans- mitting health and status data to the serial port, as well as boot progress and sensor information.
Near the beginning of this output is a line similar to:
01/01/13 00:00:02.537 <Cell> MEID = 0xA1000013F617DF
The MEID number (without the leading “0x”) is used to create your account.
FIGURE 8: twistM2M STORE SCREEN
DS00001529A-page 12 2013 Microchip Technology Inc.
Power-Up
When the unit is first powered on, it goes through an initialization process that includes attempting a connection to the Verizon Wireless network and the Twisthink server. There are a number of LEDs visible on the front cover to indicate various activities throughout the initialization process and after the unit is running in nominal mode.
LED 1 blinks rapidly when a ping message is received from the server.
LED 2 illuminates whenever the accelerometer exceeds the programmed tolerance level.
LED 3 illuminates red for a number of seconds until the PIC32 microcontroller detects the cell module. This LED will also quickly flash on and off for a number of seconds while the M2M is configuring itself.
LED 3 illuminates both red and green while the platform is attempting to connect to the Verizon Wireless net- work. When both the green and red diodes within the LED are illuminated, the LED becomes amber in color.
After the connection attempt takes place, the LED will illuminate green indicating a successful connection, or red, indicating a failure. A connection attempt may take as long as 20 seconds.
Interacting with the Web Site
The M2M Developers web site is specifically tailored to work with the example code programmed into your M2M platform.
PLATFORM PAGE
This is the first page that you are directed to when you successfully log into the M2M Developer’s Demonstra- tion web site. If your platform is active when you log into the web site, you should see the “data in/out” status indicator illuminated green in the upper right corner, as shown in Figure 10, indicating that the M2M developer web server is receiving data from your platform over the cellular phone system.
The page graphically depicts the sensor status for the accelerometer in g’s and the thermometer in degrees Fahrenheit. Although temperatures are calculated by the M2M platform in Celsius, the Twisthink web site supporting the M2M demonstration converts temperature data into Fahrenheit.
Each graph has a movable trend line that you can move using the arrows provided on the side margin.
Exposing the board to temperature changes or to shock or vibration, results in a graph similar to that shown in Figure 9. A sudden drop in temperature and a slight increase in acceleration are depicted in the graph.
FIGURE 9: PLATFORM PAGE
2013 Microchip Technology Inc. DS00001529A-page 13
DASHBOARD PAGE
This page contains three sections: Connection Status/
Reliability, Data Usage, and Device History.
Connection Status/Reliability – provides a timer that shows the elapsed time since the timer has been set. A percentage value shows the total time that the platform has been connected, which is calculated from the last time that the timer was reset.
Data Usage – shows a percentage of the available data that has been used. The total amount of available data that can be transmitted and received by the platform is a function of the data plan purchased.
Device History – provides a value of the total number of bytes transmitted per connection including the start and stop date of the connection.
FIGURE 10: DASHBOARD PAGE
DS00001529A-page 14 2013 Microchip Technology Inc.
CONSOLE PAGE
This page is divided into four sections: Text Console Message Display, Manual Ping, Download Data, and Custom (see Figure 11).
Text Console Message Display – Shows text strings sent from the device, including device reset messages and GPS location messages. In addition, “ping sent”
messages from the Web site are included.
Manual Ping – A message is sent to the platform to determine whether the web page is communicating with the platform. The ping button also has an effect on the platform’s update rate. When the M2M platform first runs, its default behavior is to send sensor data to the web site at a rate of once per hour (except for the accelerometers, which are event based and limited to once every five seconds). Once a user clicks the Ping button, the platform will begin sending sensor data at a rate of once every five seconds (i.e., all sensor data will be transmitted every five seconds for 10 minutes). After ten minutes, the platform will revert back to the default update rate.
Download Data – As the platform continues to send data, the Twisthink server receives the sensor data and stores it for seven days. A user can choose which data to retrieve from the database by selecting the appropri- ate check boxes and clicking the download button. The user will then be prompted to navigate to the location on their computer where the data will be stored as a CSV file. All data selected will be combined into a single file.
Custom – Currently, this is where the light sensor data is graphed by the demonstration program. The values sent from the platform are 0 through 1023. The web site scales the value into a percentage. To send other types of data, the user needs to replace the light sensor information within the demonstration source code with the desired data called by the A2DTask function in the a2d.c file).
For example, if an analog-to-digital value from EXT_AN1 or EXT_AN2 is desired, this can be easily accomplished by changing the message ID in the ConfigureLightDriver function from:
A2D_MSG_LIGHT_SENSOR_RATE to:
A2D_MSG_EXT_AN1_RATE or, A2D_MSG_EXT_AN2_RATE.
2013 Microchip Technology Inc. DS00001529A-page 15
FIGURE 11: CONSOLE PAGE
DS00001529A-page 16 2013 Microchip Technology Inc.
EXOSITE
Interacting With Your Device Over the Cloud
In addition to the Twisthink web Interface, Microchip has partnered with Exosite to provide support for the M2M Development Platform for CDMA on the Exosite
“One Platform” cloud-based data system.
The device can be accessed using the Exosite POR- TALS web application, or by using the open APIs Exosite provides. The Portals web application allows the user to quickly create:
• Customized dashboards
• Event triggers
• SMS/E-mail alerts
• Data processing scripts
The entire cloud-based system Exosite provides can be used as a template to quickly create your own data- driven websites, or hand-held applications, based on the same building blocks.
After creating a Portal account, you will immediately be able to interact with your device using the out-of-the- box interactive dashboard for the device. Figure 12 shows an example of the interactive dashboard.
FIGURE 12: INTERACTIVE DASHBOARD
2013 Microchip Technology Inc. DS00001529A-page 17
Enabling the Device for Exosite Communications
The platform must have a valid data plan and be acti- vated via the Twisthink portal before it can be enabled with Exosite.
To enable your platform with Exosite, follow these steps:
1. Sign up for a data plan and register with Twisthink as detailed in the “Getting Started”
section.
2. Go to microchip.exosite.com and click Sign up now!, as shown in Figure 13.
FIGURE 13:
3. From the Pricing page, select the free Community plan by clicking SIGN UP NOW, as shown in Figure 14.
FIGURE 14:
4. Fill in your details, and then click CREATE ACCOUNT, as shown in Figure 15.
FIGURE 15:
5. The system will send you an e-mail, asking you to activate your account. Activate the account and login.
6. When you log in to your new account, click the Add a new Microchip device to your dashboard link, as shown in Figure 16.
FIGURE 16:
DS00001529A-page 18 2013 Microchip Technology Inc.
7. Using the drop-down list, select Microchip M2M Development Platform for CDMA, and then click CONTINUE, as shown in Figure 17.
FIGURE 17:
8. Enter the device MEID, Name, and (optional) location, and then click CONTINUE, as shown in Figure 18.
FIGURE 18:
9. If the MEID was entered correctly, and it is not in use by someone else, the system will successfully add your device and display the Client Interface Key (CIK), as shown in Figure 19.
FIGURE 19:
10. As shown in Figure 20, copy the CIK from the previous step, and paste it into your Twisthink portal’s “m2m settings” page in the “exosite cik”
field, and then click Submit Changes (located at the bottom of the page).
FIGURE 20:
11. Your device should now be actively streaming data to Exosite’s cloud services, which can be verified in the Your Devices area of the Exosite Portal home page, as shown in Figure 21.
FIGURE 21:
12. Click the device name to go to the default dashboard, as shown in Figure 22.
2013 Microchip Technology Inc. DS00001529A-page 19
FIGURE 22:
DS00001529A-page 20 2013 Microchip Technology Inc.
Interacting With the System
The default dashboard for the device has a number of link icons at the top of the page that will allow you to fur- ther customize the system to represent the device and its data in a way that makes sense for your application.
Each of these icons, when clicked, will direct you to add new features to your Portal.
TABLE 6:
ICON Description
This icon starts the New Dashboard wizard, which allows you to create your own custom dashboard using an array of off-the shelf, or custom-coded, visual widgets.
This icon starts the New Event wizard, where you can set up triggers on incoming data.
After the event triggers are set up, you can add e-mail and SMS text alerts when the trigger is activated.
This icon starts the New Script wizard, which allows you to write Lua scripts that process data and device information real-time. Refer to www.lua.org for more information.
This icon directs you to the Portal’s Administration page where you can invite other users to view and/or manage your Portal.
This icon directs you to the Support page of the site where “how-to” videos can be watched, which provide detailed information on each of the options.
2013 Microchip Technology Inc. DS00001529A-page 21
Manage Menu
All pages of your Portal area will show a MANAGE menu on the left side of the page (see Figure 23). This menu directs you to pages that allow you to view, edit, and add to the features of your Portal.
FIGURE 23:
DATA PAGE
The MANAGE > Data page (see Figure 24) shows a list of all data that is flowing into your Portal, or being cre- ated by the real-time processing, or being used to send data back to your device. You can click on any of the data elements shown to launch a pop-up window that displays details about the data element. The “+Add Data” link at the top right, allows you to add new data elements to your device’s profile.
FIGURE 24:
DS00001529A-page 22 2013 Microchip Technology Inc.
DEVICES PAGE
The MANAGE > Devices page (see Figure 25) shows a list of all devices that are interacting with your Portal.
You can click any of the devices shown to launch a pop- up window that displays details about your device. The
“+Add Device” link at the top right, allows you to add new devices to your Portal.
FIGURE 25:
The Device pop-up window (see Figure 26) also shows the Client Identifier Key to your device. This key can be used in API calls, and on the Twisthink M2M Portal, to identify your device and to remotely interact with your device’s data or meta information.
FIGURE 26:
2013 Microchip Technology Inc. DS00001529A-page 23
SCRIPTS PAGE
The MANAGE > Scripts page (see Figure 27) shows a list of all scripts that are running in your Portal or under your devices. You can click any of the scripts shown to launch a pop-up window that allows you to edit your scripts. In this window, you will see a number of scripts are already added to your device.
The scripts shown are performing processing on incoming data to normalize the data making it easy to interact with them. The “+Add Script” link at the top right, allows you to add new scripts to your devices or to your Portal.
FIGURE 27:
DS00001529A-page 24 2013 Microchip Technology Inc.
EVENTS AND ALERTS PAGE
The MANAGE > Events page shows a list of all events and alerts that are running in your Portal or under your devices. You can click any of the events or alerts shown to launch a pop-up window that allows you to edit them.
The “+Add Event” and “+Add Alert” links allow you to add new events and alerts to your devices or to your Portal.
Events work a lot like oscilloscope triggers – you must set up the events to trigger on incoming data when the data goes “out of bounds”. Once an event is set up, you can create a new alert that is dispatched when the event is triggered.
Alerts can be either SMS or e-mail alerts, and can be set up to be transmitted one time upon trigger, or repeating until the event is no longer triggered.
Note that everything that events and alerts can do, can also be accomplished using scripts. Scripts can go even further with the complexity of the algorithms and variety of dispatch capabilities. For example, scripts can do string parsing and can dispatch to social media, such as Twitter, or an HTTP POST target.
FIGURE 28:
2013 Microchip Technology Inc. DS00001529A-page 25
DASHBOARDS PAGE
The MANAGE > Dashboards page (see Figure 29) shows a list of all dashboards that are in your Portal.
You can click the CONFIGURE button on any of the dashboards shown to launch a pop-up window that allows you to manage the dashboard.
If you click the dashboard line itself, you will be redirected to the dashboard where you can edit your custom dashboards using the WSYWIG on-screen edi- tor.
The “+Add Dashboard” link at the top right allows you to add new dashboards to your Portal.
FIGURE 29:
DS00001529A-page 26 2013 Microchip Technology Inc.
ADMIN PAGE
The MANAGE > Admin page (see Figure 30) allows you to administer Portal permissions, resources, and details. You can invite other users to view and manage your portal, check resource allotments and usages for your Portal, and change details, such as name and default dashboard.
FIGURE 30:
Going Further
To further explore the system, please sign up and log in to begin. The support page (or the external support site) has guides and videos on how to interact with the details of the system.
If you want to create your own Portal system for your business or project, you can sign up at: https://white- box.exosite.com to create a re-branded interface that is fully customizable for your needs.
2013 Microchip Technology Inc. DS00001529A-page 27
BUILDING THE PROJECT
The M2M platform comes preprogrammed with an example project that can be used “as is”. Users may want to build the demonstration project to gain knowl- edge for use when customizing the demonstration soft- ware. For example, although the M2M platform comes with Ethernet hardware, the demonstration code does not supply an Ethernet stack. Users may want to build their own stack or add Microchip’s TCP/IP Stack. The following description tells how to build the project using the MPLAB® X Integrated Development Environment (IDE). Refer to Appendix B: “Referenced Sources”
for information on how to obtain MPLAB X IDE.
To build an application, ensure that your project can find the Verizon DCF library, DCF_Framework.a, which contains the functions that interact with the cell radio and Verizon servers.
Connecting the MPLAB REAL ICE In-Circuit Emulator
The M2M platform has a RJ-11 receptacle that is used for downloading binary images and for debugging. The M2M platform is designed to be used with the MPLAB REAL ICE in-circuit emulator.
1. To connect the MPLAB REAL ICE in-circuit emulator to the M2M platform, remove the M2M top cover to expose the RJ-11 receptacle mounted inside.
2. Attach the MPLAB REAL ICE in-circuit emulator RJ-11 cable into the RJ-11 connector of the M2M platform.
3. Attach one end of a USB cable to your MPLAB REAL ICE in-circuit emulator and the other end to your PC.
Opening the Project
MPLAB X IDE is Microchip’s Integrated Development Environment (IDE) used to develop, program and debug your M2M platform software.
1. Connect an external 12V 0.5 Amp power supply into the M2M barrel adapter to power the M2M platform.
2. Start the MPLAB X IDE and select File > Open Project.
3. Navigate to the directory that contains the M2M project, as shown in Figure 31.
4. Select the project and click Open Project.
MPLAB X IDE will begin loading and parsing the project.
FIGURE 31: OPEN PROJECT DIALOG
DS00001529A-page 28 2013 Microchip Technology Inc.
Making the Project and Programming the Device
1. The MPLAB X IDE main window title bar should contain the name of the M2M project.
2. Be sure that the M2M project is the active project by right clicking on its name within the project window pane
3. Select Set as Main Project in the resulting pop-up menu.
4. Ensure that the project is configured to work with MPLAB REAL ICE in-circuit emulator by right clicking on its name within the project window pane, and then selecting Properties to open the Project Properties dialog, as shown in Figure 32.
5. Ensure that the MPLAB REAL ICE in-circuit emulator is selected, and then click Apply.
6. Ensure that the microcontroller specified in the Device field is set as PIC32MX795F512L.
7. Click Apply to accept the changes (if any), and then click OK to close the dialog box.
FIGURE 32: PROJECT PROPERTIES DIALOG
2013 Microchip Technology Inc. DS00001529A-page 29 8. As shown in Figure 33, expand the Make and
Program Device icon ( ) to open the menu, and then select Make and Program Device Main Project to rebuild the outdated file, program the microcontroller, and start a debug session.
FIGURE 33: MPLAB® X IDE DIALOG
If programming was successful, a message appears indicating the microcontroller has been programmed and is now running, as shown in Figure 34.
FIGURE 34: VERIFICATION MESSAGE
DS00001529A-page 30 2013 Microchip Technology Inc.
TEST MODE
When pressing SW2 during program initialization, the platform will enter Test mode.
To interact with the platform in Test mode, you must connect the RS-232 port to a host computer running a console program. Pressing SW2 at power-up will force the M2M platform to enter Test mode. A menu of options will be sent to the console port. Press the ESC key to abort a test. During testing, many platform fea- tures will not be available and no service from the M2M platform should be expected until the selected test item has completed. Some commands may force a soft reset. The menu is as follows:
Twisthink M2M Testing... Select Test Mode:
(1) Sensors Test
(2) 802.15.4 Radio Testing
(3) Cell pass-through mode (802.15 radio off) (4) Erase Flash
(5) EEPROM Test (6) GPS Test (7) USB Test (8) A/D Test
(ESC) Exit - Soft Reset
Press escape in any mode to return to main menu.
Enter your test number selection.
Sensor Test - Tests the light sensor, accelerometer and temperature sensors and indicates a PASS or FAIL result for each.
802.15.4 Radio Test – Opens an interactive menu that allows an operator to place the radio into one of four modes:
• Radio CW mode
• Receive mode
• Modulated Packet mode
• Receive Packet mode (an LED blinks when a packet is received)
This test also allows an operator to set the radio output power and select which antenna to use (i.e., slot antenna or coax). A PASS or FAIL result is sent to the terminal window.
Cell Pass-through Mode – Turns on the cell module and sends it AT commands until the operator presses the ESC key.
Erase Flash – This is not an actual test step, but simply a command to erase data from the SPI Flash memory device. This task should always succeed.
EEPROM Test – Performs write and read tests of the EEPROM IC. A PASS or FAIL result is sent to the terminal window.
GPS Test – Resets the GPS unit and forces it into a cold acquisition mode, which takes about two minutes to complete. New GPS data should be seen on the Text Console page of the M2M web site.
USB Test – Connect a USB cable and check for a drive to show up. Press ESC when finished.
A/D Test – Outputs the analog-to-digital value seen on each EXT_AN input. The inputs should be between 0V and 3.3V.
2013 Microchip Technology Inc. DS00001529A-page 31
APPENDIX A: SOURCE CODE
All of the software covered in this application note is available as a single WinZip archive file. This archive can be downloaded from the Microchip corporate web site at:
www.microchip.com
Note: Due to licensing restrictions, the Verizon Device Control Framework (DCF) is delivered as a single binary library.
Documentation for the DCF API is available on the Microchip M2M web page at: www.microchip.com/m2m.
DS00001529A-page 32 2013 Microchip Technology Inc.
APPENDIX B: REFERENCED SOURCES
This appendix provides information on the list of resources that are referenced in this application note.
MICROCHIP TECHNOLOGY INC.
RESOURCES
Unless otherwise stated, all resources listed are available from the Microchip web site:
www.microchip.com
PIC32 Family Reference Manual Sections
Family Reference Manual sections are available, which explain the operation of the PIC32 microcontroller fam- ily architecture and peripheral modules. The specifics of each device family are discussed in the individual family’s device data sheet.
PIC32MX795F512L Microcontroller
This 80 MHz, 1.56 DMIPS/MHz microcontroller features the 32-bit MIPS M4K® Core. Visit this web page for more information on the features and peripherals included in this device:
www.microchip.com/wwwproducts/
Devices.aspx?dDocName=en545660.
M2M
Consult this web page for information on Microchip’s M2M offerings: www.microchip.com/m2m.
MCP9800 Temperature Sensor
The MCP9800 is a digital temperature sensor capable of reading temperatures from -55°C to +125°C. Tem- perature data is measured from an integrated tempera- ture sensor and converted to digital word with a user selectable 9-bit to 12-bit Sigma Delta analog-to-digital converter.
MPLAB X Integrated Development Environment (IDE)
MPLAB X IDE is a software program that runs on a PC (Windows®, Mac OS®, Linux®) to develop applications for Microchip microcontrollers and digital signal control- lers. It is called an Integrated Development Environ- ment (IDE), because it provides a single integrated
“environment” to develop code for embedded micro- controllers. Visit this web page for more information:
www.microchip.com/mplabx.
MPLAB REAL ICE™ In-Circuit Emulator
MPLAB REAL ICE™ In-Circuit Emulator System is Microchip’s next generation high speed emulator for Microchip Flash DSC and MCU devices. It debugs and programs PIC® MCUs and Flash dsPIC® DSC with the easy-to-use but powerful graphical user interface of the MPLAB IDE, included with each plat- form. Visit the following web page for more informa- tion: www.microchip.com/realice.
MPLAB ICD 3
MPLAB ICD 3 In-Circuit Debugger System is Micro- chip's most cost effective high-speed hardware debug- ger/programmer for Microchip Flash DSC and MCU devices. It debugs and programs Flash PIC microcon- trollers and dsPIC DSCs with the powerful, yet easy-to- use graphical user interface of the MPLAB IDE. Visit the following web page for more information:
www.microchip.com/icd3.
MRF24J40 IEEE 802.15.4 2.4 GHz radio
MRF24J40 is a complete IEEE 802.15.4 radio and operates in the 2.4GHz freq band. The MRF24J40 sup- ports ZigBee, MiWi™ protocols and proprietary proto- cols to provide an ideal solution for wireless sensor networks, home automation, building automation and consumer applications.
Serial Flash (SST25VF080B)
The SST25VF080B devices are enhanced with improved operating frequency for lower power con- sumption. SST25VF080B SPI serial Flash memories are manufactured with SST's proprietary, high-perfor- mance CMOS SuperFlash® technology. The split-gate cell design and thick-oxide tunneling injector attain bet- ter reliability and manufacturability compared with alter- nate approaches.
TCP/IP Stack
Microchip offers a free licensed TCP/IP stack optimized for the PIC18, PIC24, dsPIC DSC, and PIC32 micro- controller families. The stack is divided into multiple layers, where each layer accesses services from one or more layers directly below it. Visit the following web page for more information: www.microchip.com/tcpip.
AN1204 “Microchip MiWi™ P2P Wireless Protocol”
MiWi P2P is a Peer-to-Peer Wireless Networking Pro- tocol operating on 2.4GHz IEEE 802.15.4. This docu- ment details the supported features and how to implement them. Simple, application-level data struc- tures and programming interfaces also are described.
Visit www.microchip.com/TechDocByProduct.aspx, or access the document directly through this link.
2013 Microchip Technology Inc. DS00001529A-page 33
OTHER RESOURCES
Accelerometer
The M2M platform includes an accelerometer, which is available from Analog Devices (P/N: ADXL345BCCZ- RLTR), which is capable of measuring acceleration in three axes. For more information, please visit the Analog Devices web site: www.analog.com.
DP83848 PHY
The DP83848 PHY is available from Texas Instru- ments. For more information, please visit the Texas Instruments web site: www.ti.com.
HS3001 3G-CDMA Modem
The HS3001 3G-CDMA Modem is available from Novatel Wireless. The PIC32 microcontroller communi- cates to the modem through a serial UART. For more information on this module, please visit the Novatel Wireless web site: www.nvtl.com.
Optical Sensor
The M2M platform includes a light-to-voltage optical sensor, which is available from Taos (P/N: TSL12T).
For more information visit the Taos web site:
www.taosinc.com.
MAX-6Q-0 GSP GPS Receiver
This GPS receiver is available from u-blox. For more information, please visit the u-blox web site:
www.u-blox.com.
Twisthink M2M Developer Site
From this site, you can register your M2M platform and purchase your wireless plan. For more information, please visit the Twisthink developer web site:
www.twisthinkm2m.com
Exosite One Platform and Portals
Exosite is a technology company focused on connect- ing devices and systems in the cloud. The Microchip M2M platform is supported on the “One Platform”
cloud-based data system. Exosite Portals is the web application that allows users to interact graphically with the platform. For more information, visit the following web sites:
• Portal login: http://microchip.exosite.com
• External support site: http://bit.ly/13RjDd1
• Videos: http://bit.ly/15gdiY0
Verizon M2M Developer Program
The M2M platform RF software and hardware are cer- tified under the Verizon Wireless Open Development Certification specifications, and have been approved for use on the Verizon Wireless network. For more information on the Verizon M2M Developer Program, Open Development Initiative, and the Device Client Framework, please visit the following web sites:
• http://m2mdeveloper.verizon.com/
• http://opennetwork.verizonwireless.com/
aboutOpenDev.aspx
• http://m2mdeveloper.verizon.com/learn/devices
529
age 34 2013 Microchip Technology Inc.
FIGURE C-1: SOFTWARE ARCHITECTURE BLOCK DIAGRAM
Radio Task (not implemented)
Mi-Wi
MRF24J40 Driver Temperature
Sensor Task
File System (FATS)
SPI Flash Driver
microSD Driver
USB Task
USB Driver
DCF Framework Task (Library)
I2C2
EEPROM Driver GPS Task Accelerometer
Task
UART5
Cell RX Cell
Task
I2C1 USB
Ethernet Task (not implemented)
Ethernet MAC
SPI3 SPI1 Ethernet Pins
Diagnostics UART2 UART2
Driver DCF
“Rules Engine”
Application Task Accelerometer
Temperature Sensor
GPS Module
EEPROM
Cellular Module
Serial/DB9, RS-485, or UART out
micro-USB Connector
Ethernet PHY + Connector microSD
Card 1 MB
Serial Flash 802.15.4 Radio
Task
Driver
Hardware PIC32 DCF API
Cell TX
DCF Task (Output to
Plug-in LED Task
GPIO
LEDs 1-3
Analog-to-Digital
Analog In
Light Sensor EXT_AN1 EXT_AN2
Legend:
Console) Task
Peripheral
2013 Microchip Technology Inc. DS00001529A-page 35
APPENDIX D: RF EXPOSURE INFORMATION
This product complies with FCC RF radiation exposure limits. This equipment should be installed and operated with a minimum distance of 20 cm between the radiator and your body.
This product complies with FCC RF radiation exposure limits set forth for an uncontrolled environment. The wireless system must not be co-located or operating in conjunction with any other antenna or transmitter.
FCC ID: ZPV-TT10315 IC: 9772A-TT10315
FCC Part 15.21 Information Regarding Unapproved Changes or Modifications
Changes and/or modifications not approved by the responsible party could void the user’s authority to operate the equipment.
FCC Part 15.105 Information to the User
RSS-210 Compliance
This device complies with Industry Canada RSS-210.
Operation is subject to the following two conditions: (1) this device may not cause interference, and (2) this device must accept any interference, including interference that may cause undesired operation of the device.
RSS-210 Conformité
Cet appareil est conforme avec Industrie Canada RSS- 210. Son fonctionnement est soumis aux deux conditions suivantes: (1) cet appareil ne doit pas provoquer d'interférences, et (2) cet appareil doit accepter toute interférence, y compris les interférences pouvant provoquer un fonctionnement indésirable de l'appareil.
ICES-003 Compliance Statement
This Class B digital apparatus complies with Canadian ICES-003.
Déclaration de conformité à la norme NMB-003
Cet appareil de classe B est conforme à la norme NMB- 003 du Canada.
Note: This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures:
• Reorient or relocate the receiving antenna.
• Increase the separation between the equipment and receiver.
• Connect the equipment into an outlet on a circuit different from that to which the receiver is connected.
• Consult the dealer or an experienced radio/TV technician for help.
529
age 36 2013 Microchip Technology Inc.
FIGURE E-1: M2M DEVELOPMENT BOARD (TOP VIEW)
ochip Technology Inc.DS00001529A-page 37