background image

 

 

 
 
 
 
 
 

 

 
 
 

 

 

OptC

onnect ema™

  

ema:Play User Guide  

 

 

V1.0 Updated May 2020 

Содержание EMA-L4-1-US-B-A

Страница 1: ...OptConnect ema ema Play User Guide V1 0 Updated May 2020 ...

Страница 2: ...5 3 Hardware 7 3 1 At a Glance 7 3 2 System Architecture 9 3 3 Power 9 3 4 Communications 11 3 5 Onboard MCU U16 14 3 6 Onboard Programmer Debugger 15 3 7 User Application Headers and Connectors 15 3 8 Antennas 18 3 9 Mechanical 18 3 9 1 Dimensions 18 4 Software 19 4 1 Native Development Environment 20 4 1 1 Overview 20 4 1 2 Setup and Building 20 4 1 3 Sample Program Debug Session 25 5 Reference ...

Страница 3: ...Architecture Description 46 5 5 7 Console Debug Output Sample 49 5 5 8 OptConnect Summit Portal 52 5 5 8 1 Overview 52 5 5 8 2 Login and Find ema 52 5 5 8 3 Device Attributes and Location 53 5 5 8 4 Events Usage and Analytics 54 5 5 9 Board Notify via Summit API 55 5 5 9 1 Overview 55 5 5 9 2 Create a New API Application in Summit 56 5 5 9 3 Authenticate User Application with Summit API 58 5 5 9 4...

Страница 4: ...ture LTE Bands 3G UMTS Network Region EMA L4 1 XX A A 20 00 505 40 to 85 C FDD B2 B4 B5 B12 B13 B2 B5 AT T Verizon North America EMA L4 1 US B A 20 00 005 40 to 85 C FDD B2 B4 B5 B12 B13 B2 B5 AT T Verizon United States EMA L4 1 XX A A 000 20 00 506 40 to 85 C FDD B2 B4 B5 B12 B13 B2 B5 AT T Verizon North America EMA L4 1 US B A 000 20 00 006 40 to 85 C FDD B2 B4 B5 B12 B13 B2 B5 AT T Verizon Unit...

Страница 5: ...tion 1 2 for further questions and requests in regard to the trial period 2 Overview 2 1 Contents The ema Play Evaluation Kit is shipped as a ready to use all in one platform for evaluating OptConnect ema modems for IoT M2M applications The contents of the kit are listed below 1 ema Play Evaluation Kit with without ema installed see section 1 3 for device p n s 2 OptConnect Gemini MIMO Antenna 3 5...

Страница 6: ...eedback o Temperature and humidity o Light photo o 2 user push buttons o LED cellular signal array Blue o 2 x LEDs Red User Application Headers o Input Output Application Header Access to On Board MCU 1 x i2c 1 x CAN bus 4 x UART 1 x Analog to Digital ADC 1 x Digital to Analog DAC 6 x General Purpose Input Output GPIO Access to ema communication interfaces Modem UART emaLink o Power Application He...

Страница 7: ...gures 1 3 can be used as quick reference guides for navigating the various components and features of ema Play The hardware is designed for flexibility and configurability to support different user IoT M2M applications and integration architectures and to also serve as a reference for custom hardware designs integrating ema 3 1 At a Glance Figure 1 ...

Страница 8: ... OptConnect Management LLC 2020 All rights reserved Revision 1 0 8 Figure 2 ...

Страница 9: ...wering ema Play will also determine which sub systems of the hardware are powered There are various feedback LED s that are provided to let the user know which sub systems are currently powered In addition to power input configurations ema Play also offers power output for applications requiring off board power Table 1 summarizes the power input architecture and configurations Table 2 summarizes r...

Страница 10: ...r App Hdr J4 7 4VMOD ema 4VMOD D6 MCU Interface Power U7 3 3V 3V3 Max 1A 4V 4V0 5V 5V_S2USB 5V 5V_USBJL na Test Hook 3 3V Pwr App Hdr J4 3 IO App Hdr J5 12 3 3V 3 3V D7 ema IOVREF Min 1 8V IO_VREF Max 5 5V IO_VREF 3 3V 3V3 External via Pwr App Hdr J4 9 Pwr App Hdr J4 9 Test Hook VIOREF1 VIOREF2 ema IO interface na Table 1 Onboard MCU U16 must be held in reset if IOVREF is supplied as 4 1V Descript...

Страница 11: ...em UART using RS232 from an external device to send AT commands RS422 RS485 4 Wire to Board Terminal J2 3 J2 6 Board to Board Terminal J1 3 J1 6 Dipswitch SW2 Slide Switch SW4 This interface can be used to access the ema Modem UART using RS422 RS485 full duplex from an external device to send AT commands RS485 2 Wire to Board Terminal J2 3 J2 4 Board to Board Terminal J1 3 J1 4 Dipswitch SW2 Slide...

Страница 12: ...1 J5 24 This interface can be used to access the Onboard MCU U16 using an external embedded device using UART S2USB Enhanced Comm Port S2USB USB Port J10 This interface can be used as a debug console input output port for the Onboard MCU U16 i2c External Device IO App Hdr J5 13 J5 14 This interface can be used to interface to the Onboard MCU U16 using an external device over i2c CAN External Devic...

Страница 13: ...f Switch Configuration ema Modem UART Interface S2USB Standard Comm Port S2USB USB Port J10 Dipswitch SW2 S2USB RS232 Wire to Board Terminal J2 3 J2 6 Board to Board Terminal J1 3 J1 6 Dipswitch SW2 Slide Switch SW4 Ser 232 RS422 RS485 4 Wire to Board Terminal J2 3 J2 6 Board to Board Terminal J1 3 J1 6 Dipswitch SW2 Slide Switch SW4 Ser 485 4 RS485 2 Wire to Board Terminal J2 3 J2 4 Board to Boar...

Страница 14: ...elop their own custom IoT M2M applications using ema There are various sensors peripherals and LED s integrated into the ema Play hardware that can be accessed by U16 Please visit the following website for more information regarding the onboard MCU U16 https www microchip com wwwproducts en ATSAME51J20A Table 6 summarizes the various sensors and peripherals available to U16 for customization Senso...

Страница 15: ...ctor J11 is provided for use with any compatible external ARM Cortex ICP D For more information regarding the onboard Segger JLink ICP D please visit this website https www segger com products debug probes j link models j link ob 3 7 User Application Headers and Connectors ema Play provides a wire to board screw terminal connector J2 and a board to board shrouded connector J1 to interface to exter...

Страница 16: ...mable in ema via an AT command 8 EMA_STS This signal can be monitored by an external device It will go high IO_VREF when ema s communication interfaces become ready Table 7 The power application header J4 can be used to control various power functions on ema Play as well as ema Table 8 summarizes the signals relative to J4 J4 Pin Number J4 Signal Name Usage Example 1 4V0 This signal can be used to...

Страница 17: ...force a hardware reset of the onboard MCU U16 8 MOD_DTR This signal can be used by an external device to assert the Data Terminal Ready DTR signal for ema 9 OB_uP_AIN This signal can be used by an external device to input an analog voltage max 3 3V for reading by the onboard MCU U16 11 OB_uP_DAC This signal can be used by the onboard MCU U16 to generate analog voltage max 3 3V for use by an extern...

Страница 18: ...these adaptors should be carefully connected to ema after it has been seated correctly in the modem socket J7 J8 Table 10 lists recommended antennas for use with ema Play Type Manufacturer Part Number External Cellular Antenna Taoglas TG 30 8113 External Cellular Antenna Taoglas GSA 8841 A 105111 External Cellular MIMO Antenna 2J 2J7724Ma Table 10 Available from OptConnect 3 9 Mechanical 3 9 1 Dim...

Страница 19: ...p software for ema Play and ema and are by no means the only methods and techniques that can be used There are four main methods for interfacing software with ema using ema Play 1 Develop software that runs on ema Play onboard MCU U16 This method closely follows the procedure outlined in section 4 1 and involves a technical understanding and knowledge of writing code for embedded systems Typically...

Страница 20: ...r Application Headers J4 J5 Additionally built in features of ema Play can also be accessed using this method See section 3 5 and 3 7 Reference section 5 4 4 and 5 4 5 for ema Play configuration to support this method 4 1 Native Development Environment 4 1 1 Overview ema Play has an onboard MCU U16 that is provided for custom user applications utilizing ema as the cellular connection This section ...

Страница 21: ...in the file Reference section 1 2 for more information 3 Launch Atmel Studio 7 Once the software is launched the landing page should look similar to Figure 5 Figure 5 4 Open the project Open the GettingStartedWithemaVx x sample project by clicking on the Open Project link or selecting File then Project Solution and navigating to the location of the GettingStartedWithema atsln file that was obtaine...

Страница 22: ...to quickly configure the drivers and middleware for the onboard MCU U16 For this project the following peripherals have already been configured Reference Figure 8 ADC_0 Analog to digital converter driver used to convert voltages EMAPLAY_DEBUG_UART UART communications between U16 and the S2USB enhanced COMM port J10 used for console debug I O I2C_0 i2c communications between U16 and the onboard tem...

Страница 23: ...nfigurator in Atmel Start On the left side of the screen click on the button labeled Go to PINMUX Configurator as shown in Figure 9 Figure 9 This will pull up the PINMUX Configurator where the ema Play user can change the pin settings on U16 Note that the column labeled User Label is the reference that can be seen in the API calls from the source code See Figure 10 Atmel Start API documentation ca...

Страница 24: ...eferences are used in the API calls in the int main void function This is a simple demonstration of the correlation between the Atmel Start tool and the source code references Reference Figure 11 Figure 11 8 Build the project Click Build then Build Solution or simply press F7 to compile the source code and build the project The Output window can be observed for any errors There should not be any e...

Страница 25: ...apacity 1 Connect ema Play JLink ICP D to computer Locate the onboard JLink Programmer Debugger port J13 and connect it to the computer running Atmel Studio 7 Right click on the GettingStartedWithema project folder and select Properties The project properties window appears On the left side click on the Tool tab then select the J Link programmer debugger from the list as shown in Figure 13 Figure ...

Страница 26: ...k Control Panel Confirm that the Device is set to ATSAME51J19 as shown in Figure 14 If it s not set to this click on the Settings tab and select the correct device next to the check box Override device selection as shown in Figure 15 Figure 14 Figure 15 There is an identified issue with Atmel Studio 7 that does not allow the ATSAME51J20A to be used by the JLink Utility Close the JLink Control Util...

Страница 27: ... click the tab labeled Memories Next click the Program button Atmel Studio 7 will use the onboard JLink programmer to program the firmware into the ema Play onboard MCU U16 program flash Once complete ema Play Blue LEDs signal array D14 D17 should continue to scroll Reference Figure 17 Figure 17 ...

Страница 28: ...lopers should review carefully and use as needed to help with custom hardware and software Schematics PCB Layout and sample code projects can be requested Refer to section 1 2 or visit http optconnect com ema for the latest versions of these documents and projects The following sections include copies of ema Play design files for quick reference and further design considerations ...

Страница 29: ... OptConnect Management LLC 2020 All rights reserved Revision 1 0 29 5 1 Schematics ...

Страница 30: ... OptConnect Management LLC 2020 All rights reserved Revision 1 0 30 ...

Страница 31: ... OptConnect Management LLC 2020 All rights reserved Revision 1 0 31 ...

Страница 32: ... OptConnect Management LLC 2020 All rights reserved Revision 1 0 32 ...

Страница 33: ... OptConnect Management LLC 2020 All rights reserved Revision 1 0 33 ...

Страница 34: ... OptConnect Management LLC 2020 All rights reserved Revision 1 0 34 ...

Страница 35: ... OptConnect Management LLC 2020 All rights reserved Revision 1 0 35 ...

Страница 36: ... OptConnect Management LLC 2020 All rights reserved Revision 1 0 36 ...

Страница 37: ... OptConnect Management LLC 2020 All rights reserved Revision 1 0 37 5 2 Bill of Materials BOM ...

Страница 38: ... OptConnect Management LLC 2020 All rights reserved Revision 1 0 38 ...

Страница 39: ... OptConnect Management LLC 2020 All rights reserved Revision 1 0 39 5 3 Assembly Reference ...

Страница 40: ...et connection Both the Modem UART and emaLink interfaces are connected directly to the MCU as shown below AT commands are used to control ema 5 4 2 External S2USB control In this configuration an external host such as a Windows or Linux environment controls ema through use of ema Play s S2USB port J10 This configuration can also be used to manually send AT commands via a Terminal program The Modem...

Страница 41: ...this configuration an external USB host driver controls ema through use of ema s direct USB interface via ema Play s USB port J6 This configuration requires the host system to support ema USB host drivers These drivers are available from OptConnect Refer to section 1 2 for the best way to obtain these drivers ...

Страница 42: ...ost device that supports RS232 RS485 RS422 can be used to access ema s Modem UART interface via ema Play s screw terminal block J2 or shrouded connector J1 This configuration is useful in industrial and commercial applications where the desired host system is a machine PLC or similar If the interface used is selected to be RS485 RS422 then the host system can be located long distances from ema and...

Страница 43: ...mple project integrates Canopy s endpoint agent Leaf to provide the link between the ema Play hardware and the Canopy IoT Platform Autonomously ema will also be managing the cellular connection The OptConnect Summit portal https summit optconnect com login can be used to track ema s management activities 5 5 2 Features Supported Demonstrated ema startup and initialization recovery and shutdown ema...

Страница 44: ... output of ema Management UART interface traffic define DBG_EMA_LINK_AT_HEX 0 console output of ema Management UART interface traffic in hex format define DBG_EMA_LINK_URC 0 console output of ema URCs define DBG_EMA_LINK_URC_HEX 0 console output of ema URC hex format define DBG_APPLICATION 1 console output of ema main application debug messsages endif functionality define OPT_RECOVER_EMA 1 1 force...

Страница 45: ...unction specific console debug control in file emaPlay_config h The COM port settings for the console debug interface are 115200 8 N 1 The COM port will enumerate with the computer as an Enhanced COM Port COMxxx Pressing in the console will list the currently active console Cmds as shown Current console Cmd descriptions d ema Play and ema status data This cmd will list the status of all relevant d...

Страница 46: ...d usage example of the Canopy IoT dashboard Input Type Output Type Temperature sensor LED 1 red LED D18 Relative Humidity sensor LED 2 red LED D19 Light Intensity sensor Digital Output 1 IO app header pin J5 4 System Voltage analog Digital Output 2 IO app header pin J5 3 ema Voltage analog Signal Quality LED bar graph State D14 D17 User ADC analog Push Button 1 switch SW7 Push Button 2 switch SW8 ...

Страница 47: ...ment LLC 2020 All rights reserved Revision 1 0 47 The runtime environment is bare metal to demonstrate that the most resource constrained designs can work easily with ema A simplified flow chart of the software is shown ...

Страница 48: ... any relevant data to and from the IoT cloud platform Once the demo is started the state machine powers on ema and the cellular module checks network status checks starts the data session initializes the Leaf agent then enters a normal operations state User events and periodic delta statistic messages will create and build JSON messages to be sent to the cloud emaPlay_scan_analog_inputs This funct...

Страница 49: ... OptConnect Management LLC 2020 All rights reserved Revision 1 0 49 5 5 7 Console Debug Output Sample ...

Страница 50: ...old SW7 to start the demo 11202 After holding SW7 ema Play is applying power to ema and waiting for the appropriate URC 14211 URC detected ema Play has set its Board ID via ema to be reported to Summit 14211 ema Play detected ema is powered on and is now powering on the cellular module and waiting for the appropriate URCs 29858 URCs detected Cellular module is now powered on and ready 29858 ema Pl...

Страница 51: ...lding the Leaf event message 86803 ema Play is sending the Leaf event message via HTTPS 142182 ema Play is periodically checking the carrier network status using OptConnect Glimpse 149869 ema Play received a Board Notify message from the cloud with LED control data 1261471 ema Play outputted status data as a result of the user inputting the d cmd 1271703 The user has instructed ema Play to gracefu...

Страница 52: ...creation and login credentials refer to section 1 2 5 5 8 2 Login and Find ema 1 Confirm that ema Play and ema are powered ON and allow ema up to 30 seconds to establish a connection to OptConnect services 2 Navigate to https summit optconnect com login and login to the portal The landing page should look similar to Figure 23 All of the OptConnect cellular devices associated with this account will...

Страница 53: ...n can be used to investigate ema s Board ID IP address Last check in etc Certain fields Device ID and Description can also be edited accordingly Reference Figure 25 Note the board ID that was set by ema Play in the sample log in section 5 5 7 Figure 25 2 The APPROXIMATE DEVICE LOCATION section can be used to view ema s location Reference Figure 26 ...

Страница 54: ... 26 5 5 8 4 Events Usage and Analytics 1 The EMA EVENTS section can be used to closely monitor ema s behavior over time Reference Figure 27 Figure 27 2 The DATA USAGE HISTORY and SIGNAL ANALYTICS sections can be used to monitor ema s usage and signal data Reference Figure 28 ...

Страница 55: ...ccount and associated devices Reference the Summit API Docs webpage at https docs optconnect com documentation This section demonstrates ema s Board Notify feature using ema Play Board Notify is a powerful but simple feature that allows any internet connected device to send small chunks of data to ema using the Summit API secure channel This allows the user s host application utilizing ema to rema...

Страница 56: ...screen click on the MENU button In the menu click on Manage API Apps as shown in Figure 29 Figure 29 2 Click on the New API Application button as shown in Figure 30 Figure 30 3 The Create New Summit API Application page will load Enter a Name and Description for this API application Select the appropriate Application Roles and Account Access settings for this API Application then click Create as s...

Страница 57: ... is clicked a window will pop up asking to copy the App Secret Copy the App Secret and save it in a secure location for later use Close the App Secret pop up page The Application Details page should now be displayed as shown in Figure 32 Note the Account ID and the Application ID for later use Figure 32 ...

Страница 58: ...in the previous section follow the steps below 2 Any application with access to the internet can use the Summit API The application must authenticate with the Summit API using the Account ID Application ID and APP Secret On the Summit Developers landing page scroll down and click on the POST button next to the Authentication endpoint accounts login app_secret as shown in Figure 33 Figure 33 3 Clic...

Страница 59: ... OptConnect Management LLC 2020 All rights reserved Revision 1 0 59 Figure 34 ...

Страница 60: ... Summit API endpoint is used to instruct the ema Play red LED D18 to flash with a duty cycle of 500 ms and a period of 1000 ms Enter the command data as shown in Figure 36 and click on the blue Execute button Within a few seconds the query should respond and the ema Play red LED D18 should start flashing The ema Play debug console can also be monitored to view the Board Notify data that was receiv...

Страница 61: ... OptConnect Management LLC 2020 All rights reserved Revision 1 0 61 Figure 36 Figure 37 ...

Страница 62: ...s running the Leaf agent which connects the ema Play endpoint hardware to the Canopy dashboard The following section will briefly outline the Canopy dashboard relative to ema Play and demonstrate a simple IoT Campaign to automate a task This section assumes that the users Canopy account has been setup successfully and the user can login to the Canopy dashboard For questions regarding Canopy accoun...

Страница 63: ...ese steps 1 Click on the associated ema serial number to go to the Devices tab as shown in Figures 39 40 Figure 39 Figure 40 2 Click on the Events sub tab as shown in Figure 40 This will load and list all Leaf messages that are being transacted between the ema Play hardware and the Canopy dashboard Figure 41 below illustrates what this could look like This information can be used for debugging pur...

Страница 64: ...ermore statistic type messages have also been received updating the KPI state of the telemetry data that can be viewed on the Operations tab 5 5 10 4 Control Actions The ema Play demonstration project combined with the Leaf agent is pre programmed to handle and process commands from the Canopy servers These are known as Actions The following steps will demonstrate how easy it is to command ema Pla...

Страница 65: ...ill command ema Play to control it s LED 1 ref des D18 to flash at a frequency of 2 Hz Figure 43 3 Click the Control Output button to close this window Click the Control Output confirmation button to send the command as shown in Figure 44 Figure 44 At this point the Canopy servers will post the command data for retrieval by the next ema Play Leaf request This can take up to 10 seconds Observe on t...

Страница 66: ...es at the endpoint hardware ema Play This section will demonstrate how to setup and use IoT Campaigns To do this we will use ema Play s built in light sensor push button and one of the two controllable LED s to simulate a security application The high level goal is to toggle an output when light intensity goes above a certain threshold and to be able to press a button to disable the output Referen...

Страница 67: ...e Field and Alarm Trigger in the Description Field and click Add as shown in Figure 46 Figure 46 3 The IoT Campaign canvas page will load and should look similar to Figure 47 The canvas is where the logic for the Intruder Flash Light Detected IoT Campaign can be designed The left side of the screen includes the modules that can be dragged onto the canvas and interconnected with other modules Figur...

Страница 68: ...anization Device etc Click on Start Campaign as shown Figure 48 5 Repeat steps 2 4 above to create another IoT Campaign named Disarm System with description Disable Alarm Use Figure 49 as reference for the logic Start the Campaign and return to the IoT Campaigns page Figure 49 6 The two campaigns that were just created should be listed as shown in Figure 50 They should show Active in the Status co...

Страница 69: ...and shine it at the light detector Q2 on ema Play while observing the Light column on the Operations page for the appropriate device Confirm that within 10 seconds of the value crossing the threshold 1000 LED 1 begins to Flash Reference Figures 51 52 Figure 51 Figure 52 10 The alarm has been triggered It turns out it was a false alarm so now it s time to disable the alarm Use the second IoT Campai...

Страница 70: ...grammed input and outputs Reference section 5 5 6 for a complete list of these For example ema Play could be placed inside of a piece of equipment provide the internet connection via ema and monitor the temperature Using Canopy and IoT Campaigns if the temperature crossed a threshold an email could be sent to an authority to take corrective action All of this would require no technical work and de...

Страница 71: ... OptConnect Management LLC 2020 All rights reserved Revision 1 0 71 6 Revision History Revision Date Description Author 1 0 5 14 2020 Initial Release MSV ...

Отзывы: