OptConnect ema:Play User Manual

Hide thumbs

Table Of Contents

Table of Contents

Quick Links

Download this manual

OptConnect ema™

ema:Play User Guide

V1.0 Updated May 2020

Table of Contents

Need help?

Do you have a question about the ema:Play and is the answer not in the manual?

Questions and answers

Summary of Contents for OptConnect ema:Play

Page 1 OptConnect ema™ ema:Play User Guide V1.0 Updated May 2020...
Page 2: Table Of Contents
3.7 User Application Headers and Connectors 3.8 Antennas 3.9 Mechanical 3.9.1 Dimensions Software Native Development Environment 4.1.1 Overview 4.1.2 Setup and Building 4.1.3 Sample Program/Debug Session Reference Schematics Bill of Materials (BOM) Assembly Reference © OptConnect Management, LLC 2020. All rights reserved. Revision 1.0...
Page 3 5.5.10 Banyan Hills Canopy IoT™ Platform 5.5.10.1 Overview 5.5.10.2 Login and Find ema:Play 5.5.10.3 Device Operations and Leaf Messaging 5.5.10.4 Control Actions 5.5.10.5 Automation using IoT Campaigns 5.5.10.6 Summary Revision History © OptConnect Management, LLC 2020. All rights reserved. Revision 1.0...
Page 4: Introduction
OptConnect ema™ modems. ema:Play provides easy access to the features of OptConnect ema™ modems, and acts as a launching point for translation into custom IoT/M2M applications using OptConnect ema™. This document serves as a guide and point of reference for using ema:Play correctly and efficiently.
Page 5: Additional Resources
If ema is not activated/registered upon receipt, please visit https://summit.optconnect.com/ema to activate/register ema. Once activated, ema:Play includes a free trial period that will last for three months, with 1 GB of data being available per month. Please contact OptConnect (see section 1.2) for further questions and requests in regard to the trial period.
Page 6 Easy grab test points for measurements • Efficient design • Cost and availability optimized Antenna adaptors built in • U.FL to SMA for both main and diversity Electrical design CAD available for reference • © OptConnect Management, LLC 2020. All rights reserved. Revision 1.0...
Page 7: Hardware
3. Hardware Section 3 outlines the hardware of ema:Play from a user perspective. Figures 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.
Page 9: System Architecture
Furthermore, depending on which connector/port is powering 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.
Page 10 Application headers Onboard IOVREF This signal can be used to set ema’s IOVREF level OB_uP_IOVREF_DIS (J5.28) Onboard 3.3V IOVREF disable from an external source Table 2 © OptConnect Management, LLC 2020. All rights reserved. Revision 1.0...
Page 11: Communications
3.4 Communications ema:Play provides several useful and common communication interfaces for sending and receiving data to and from ema. Additionally, standard interfaces are offered to communicate directly with the Onboard MCU (U16) for further flexibility. Refer to the following tables for identifying which interface will work best for the application: Table 3 summarizes the ema Modem, emaLink, and USB Interface configurations.
Page 12 MCU. Table 4 ema:Play has built in configuration switches to allow the user to easily select which communication interface to use in their application. Alternatively, the Onboard MCU (U16) can be used to control the communication interface selection via custom firmware. The architecture is such that the ema Modem UART signals and the emaLink interface signals can be directed according to Table 5 using dipswitches (SW2, SW3), and the slide switch (SW4).
Page 13 Table 5 summarizes how to configure the ema:Play hardware for the desired ema interface. Alternatively, the switch settings are also labeled on the ema:Play PCB silkscreen for quick reference. Desired Desired Access Port ema:Play Switch Configuration ema Interface (ref) Interface...
Page 14: Onboard Mcu (U16)
Table 5 3.5 Onboard MCU (U16) ema:Play provides an onboard MCU (U16) to allow users to develop 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...
Page 15: Onboard Programmer/Debugger
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 external devices and allow them direct access to ema, or the onboard MCU (U16).
Page 16 EMA_STS (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...
Page 17 Unused Table 8 The IO application header (J5) can be used to control, monitor, and interface with various signals and systems throughout the ema:Play hardware, as well as ema. Table 9 summarizes the signals relative to J5. J5 Pin Number...
Page 18: Antennas
Table 9 3.8 Antennas ema:Play provides two U.FL to SMA antenna adaptor cables. The external antennas should be connected at the SMA ends of the adaptor cables (primary-J3, diveristy-J12). The U.FL ends of these adaptors should be carefully connected to ema after it has been seated correctly in the modem socket (J7/J8).
Page 19: Software
The PCB assembly for ema:Play includes a 40 mil(.0400 inches) clearance area along both short sides(x) of the PCB assembly along the edge. This allows the PCB assembly to slide into an enclosure that is suitable for the slide mounting method.
Page 20: Native Development Environment
2. Develop software that runs external to ema:Play on a host platform that has a standard serial COMM interface. This method requires that ema:Play be connected to the host platform using the S2USB USB interface (J10). The most common host platform in this scenario is a standard computer with a terminal program.
Page 21 The installation will take several minutes to complete. 2. Obtain the latest GettingStartedWithemaVx.x.zip firmware package: Go to http://optconnect.com/emaPlay , or reach out to an OptConnect representative to obtain 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.
Page 22 COMM port (J10), used for console debug I/O. I2C_0 i2c communications between U16 and the onboard temperature/humidity sensor (U1). EMA_MGMT_UART UART communications between U16 and emaLink. EMA_MODEM_UART UART communications between U16 and the ema Modem UART. © OptConnect Management, LLC 2020. All rights reserved. Revision 1.0...
Page 23 “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.
Page 24 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 errors if using the provided project. Reference Figure 12. © OptConnect Management, LLC 2020. All rights reserved. Revision 1.0...
Page 25: Sample Program/Debug Session
This section continues from section 4.1.2 and demonstrates how to program the firmware into the ema:Play onboard MCU (U16). Atmel Studio 7 can also be used to step through code in a debug capacity. 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.
Page 26 JLink Utility Close the JLink Control Utility and Click “Read”. The “Device Signature” and “Target Voltage” will be read from the onboard MCU (U16) as shown in Figure 16. © OptConnect Management, LLC 2020. All rights reserved. Revision 1.0...
Page 27 On the left side, 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.
Page 28: Reference
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. © OptConnect Management, LLC 2020. All rights reserved. Revision 1.0...
Page 40: Sample Ema:play Configurations
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 UART interface (standard COM port, 115200,8,N,1) can be accessed directly using this method.
Page 41: External Usb Control
In 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.
Page 42: External Mcu Control
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 ema:Play. Auto-direction control is built into ema:Play so there is no need to control the ema:Play driver enable (DE) signal when using RS485. This configuration does not allow access to the emaLink interface.
Page 43: Sample Project - Getting Started With Ema
The overall goal of this sample project is to demonstrate a simple IoT application, where the ema:Play is using ema as its cellular internet connection, to send and receive ema:Play telemetry data to an IoT cloud platform.
Page 44: Software Project Hierarchy
// change in sys voltage #define SIG_Q_DELTA // change in sig q or "bars" #define LIGHT_DELTA // change in light adc % #define USER_ADC_DELTA // change in user adc % #endif © OptConnect Management, LLC 2020. All rights reserved. Revision 1.0...
Page 45 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 data to the project: Example: ‘s’ = Start/Stop demo. This cmd will start and stop (graceful ema shutdown) the demo project.
Page 46: Software Architecture & Description
Searching for cellular network, and/or acquiring signal All Flashing An error has occurred 1 – 4 LEDs ON solid Indicating current signal quality D14 – D17 LED State Reference Table © OptConnect Management, LLC 2020. All rights reserved. Revision 1.0...
Page 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. © OptConnect Management, LLC 2020. All rights reserved. Revision 1.0...
Page 48 The low-level reading and debouncing of the actual MCU pin(s) occurs on a timer interrupt. dbg_task(): This function handles any queued console debug output as well as reading any console input. © OptConnect Management, LLC 2020. All rights reserved. Revision 1.0...
Page 50 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.
Page 51 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 gracefully shutdown ema by pressing and Holding SW7.
Page 52: Optconnect Summit Portal
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.
Page 53: Device Attributes And Location
1. The “DEVICE ATTRIBUTES” section 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.
Page 54: 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. © OptConnect Management, LLC 2020. All rights reserved. Revision 1.0...
Page 55: Board Notify Via Summit Api
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.
Page 56: Create A New Api Application In Summit
5.5.9.2 Create a New API Application in Summit 1. Navigate to https://summit.optconnect.com/login and login to the portal. In the top right area of the screen, click on the “MENU” button. In the menu, click on “Manage API Apps” as shown in Figure 29.
Page 57 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 © OptConnect Management, LLC 2020. All rights reserved. Revision 1.0...
Page 58: Authenticate User Application With Summit Api
“Execute” button to make the request. A successful request will return an API Key and an SDK Token (JSON Web Token), which should be saved and used in subsequent Summit API calls. Reference Figure 34. © OptConnect Management, LLC 2020. All rights reserved. Revision 1.0...
Page 60: Send Data To Ema Using Board Notify
“reboot_ema_play” In this example, this 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”...
Page 62: Banyan Hills Canopy Iot Platform
Canopy™ is coupled with Banyan Hills Leaf Agent, running on ema:Play’s demonstration project, and using ema as the internet connection. This allows for a simple device to cloud round trip relationship utilizing ema:Play’s onboard sensors, digital inputs, and digital outputs.
Page 63: Device Operations And Leaf Messaging
5.5.10.3 Device Operations and Leaf Messaging A useful tool that can be accessed from the Canopy dashboard is the JSON structure Leaf messaging data that is being sent over the cellular connection from the ema:Play hardware. To access this information, follow these steps: 1.
Page 64: Control Actions
10:32:50 AM. The JSON data shows that the event that triggered this message was “sw2_state”:1. This indicates that a button(ref des SW8) was pressed and released on the ema:Play hardware. Furthermore, statistic type messages have also been received updating the KPI state of the telemetry data that can be viewed on the “Operations”...
Page 65 2. Click on the “Control Output” button to open the Control Output window. Select “LED 1” from the Output drop down, enter 500 for Duty, and enter 1000 for Period as shown in Figure 43. This will command ema:Play to control it’s LED 1 (ref des D18) to flash at a frequency of ~2 Hz. Figure 43 3.
Page 66: Automation Using Iot Campaigns
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.
Page 67 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. Figure 47 © OptConnect Management, LLC 2020. All rights reserved. Revision 1.0...
Page 68 “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” column. © OptConnect Management, LLC 2020. All rights reserved. Revision 1.0...
Page 69 Use the second IoT Campaign Disarm System to disable the alarm and stop LED 1 from flashing. According to the logic of this IoT Campaign, press SW 1 (ref des SW7) on ema:Play to stop the LED from flashing. Allow 10 seconds for the LED to stop flashing.
Page 70: Summary
The demonstration above may not seem all that useful in a real-world application, but it could easily be adjusted using the IoT Campaign canvas and logic to monitor and react to any of ema:Play’s preprogrammed 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.

This manual is also suitable for:

Ema-l4-1-xx-a-a Ema-l4-1-us-b-a Ema-l4-1-xx-a-a-000 Ema-l4-1-us-b-a-000 Ema-zz-1-xx-z-b Ema-l4-1-xx-a-b ... Show all

OptConnect ema:Play User Manual

1 Introduction

2 Overview

3 Hardware

4 Software

5 Reference

6 Revision History

Quick Links

Need help?

Questions and answers

Related Manuals for OptConnect ema:Play

Summary of Contents for OptConnect ema:Play

This manual is also suitable for:

Table of Contents