Shimmer 3 User Manual

Hide thumbs Also See for 3:

User manual (29 pages)

Getting started (18 pages)

User manual (16 pages)

Table Of Contents

Quick Links

Download this manual

Realtime Technologies Ltd

Shimmer User Manual

Rev3p

Shimmer User Manual

Revision 3p

Table of Contents

Need help?

Do you have a question about the 3 and is the answer not in the manual?

Questions and answers

Summary of Contents for Shimmer 3

Page 2 FAR 52.227-7013.The Shimmer logo is a registered trademark of Realtime Technologies Ltd. Other brands, marks and names mentioned herein may be the property of their respective owners and used in accordance with published guidelines.
Page 3: Informed Consent Statement
By your use of Shimmer you acknowledge these and other risks inherent in the use of an experimental device and you assume full responsibility for testing this device with human subjects.
Page 4: Agency Compliance
Agency Compliance Contains FCC ID: X2W-SR7-1 The FCC ID marking label is attached to the back of the Shimmer and is to remain attached at all times to comply with FCC requirements for Modular approval: Here is an example of the text on the FCC ID marking label:...
Page 5: Welcome Message
USB. It is recommended that you browse the contents of the Shimmer User Resources by initially opening the README file in your web browser and following the appropriate links. Updated versions of the items in the Shimmer User Resources may also be available for download from the Shimmer website.
Page 6: Table Of Contents
LogAndStream LED Indication ....................2 2.3. Charging the Shimmer ......................4 2.4. Pairing a Shimmer ........................4 2.5. Setting up a Shimmer data stream ..................7 Shimmer3 Platform Overview .................... 14 3.1. Components ........................14 3.2. Shimmer Dock........................18 3.3.
Page 7 Copyright © Shimmer 2017 Realtime Technologies Ltd Shimmer User Manual All rights reserved Rev3p Troubleshoot ........................55 References ......................... 57 Appendices ........................58 9.1. Appendix A - Mainboard detail for Debug and Testing ............58 9.2. Appendix B - Legacy Support ....................64 9.3.
Page 8: Introduction
Shimmer3 device. Much of the information applies generically to Shimmer Products. If you are new to the Shimmer platform, there is Quickstart information in Section 2, whilst Section 3 gives a high level overview of the Shimmer platform. Section 2 (Quickstart) is essential reading, Section 3 (Shimmer Platform Overview) is recommended reading and the remaining sections are best browsed based on personal interest and development goals.
Page 9: Quickstart
This Quickstart guide is aimed at those who do not have access to the online instructions and its purpose is to allow those users to swiftly get up and running with their Shimmer sensing platform on both a Windows OS and Linux OS. For a more in depth understanding of the Shimmer platform please refer to the later sections of this User Manual.
Page 10 1s Blue/1s Green Logging Figure 2-3 LED indicators for LogAndStream (Location B and A) Note: The above SD error LED sequence is present in LogAndStream_v0.8.0 and later. Older versions of LogAndStream couple both SD and RTC errors into a 0.1s Blue/0.1s Green LED flashing sequence.
Page 11: Charging The Shimmer
Rev3p 2.3. Charging the Shimmer A Shimmer unit may be charged using a Shimmer Dock, Multi Charger, a Shimmer charging cable or a Consensys Base. This section is limited to the description of the Shimmer Dock (referred to as "the Dock"...
Page 12 Search for Shimmer Devices To add a Shimmer to the list of devices connected with the PC, select the Add a Device button on the top left of the window (see screenshot on left of Figure 2-5). Windows will now search for Bluetooth devices that are within range of your PCs BT radio and display them as in the screenshot on the right of Figure 2-5.
Page 13 Windows machine should now include the Shimmer that you paired (see Figure 2-7). In order to use the device with many host side Shimmer applications, it is essential to know the COM port that the Windows machine has assigned to the Shimmer. To identify the COM port number, right click on the Shimmer, select Properties and go to the Services tab.
Page 14: Setting Up A Shimmer Data Stream
Scanning ... 00:06:66:42:22:BD RN42-22BD 00:A0:96:28:DF:E8 FireFly-DFE8 00:06:66:42:24:18 RN42-2418 Pair to a Shimmer device To use the Shimmer, for example, with Bluetooth radio ID “RN42-2418”, it must be bound to an rfcomm device. The command achieves this. The parameter rfcomm bind <n>...
Page 15 Ensure the Shimmer unit is powered on and press the Connect button on the ShimmerCapture application to establish a Bluetooth connection between the Shimmer and the host side machine. As per Figure 2-3, the blue LED on the Shimmer will remain on when a successful connection has been made.
Page 16 Press the Start Streaming button to start the Shimmer streaming data to the ShimmerCapture application. The blue LED on the Shimmer will blink with a 50% duty cycle at a rate of 0.5Hz (1s ON – 1s OFF). The data is displayed on the screen as in Figure 2-10.
Page 17 Ensure the Shimmer unit is powered on and running LogAndStream firmware (v0.8.0 or later), then press one of the Connect buttons highlighted in Figure 2-12. The blue LED on the Shimmer will turn continuously on when a successful connection has been made.
Page 18 Realtime Technologies Ltd Shimmer User Manual All rights reserved Rev3p Figure 2-12 Connecting to the Shimmer Accessing the Shimmer configuration To configure the Shimmer, select one of the Configure buttons as shown below in Figure 2-13. Figure 2-13 Accessing the Shimmer configuration...
Page 19 Press one of the Start Streaming buttons to start the Shimmer streaming data to the Consensys application. The blue LED on the Shimmer will blink with a 50% duty cycle at a rate of 0.5Hz (1s ON – 1s OFF). The data is displayed on the screen as in Figure 2-15.
Page 20 Recording data from the Shimmer Data can be stored to the PC (via a Consensys database) and/or locally to the Shimmer’s SD card as shown in Figure 2-16. It can then be exported to a text file for data visualtation or data processing.
Page 21: Shimmer3 Platform Overview
This section provides an overview of the main components of the Shimmer3 platform. The scope and level of detail provided here is aimed at the general Shimmer user and should be sufficient for understanding the core concepts of the Shimmer3 platform. For more specific and detailed information, please refer to the later sections of this document along with the additional user guides, which are referred to throughout the document.
Page 22 All rights reserved Rev3p Figure 3-1 shows the individual components of the Shimmer3. To open the case, loosen the two screws with a T-6 Torx screwdriver and open the case carefully by pulling up on the screw side and carefully disengaging the tabs on the opposite side of the unit. Note the position of the PCB, wires, button, slide-switch actuator (if present), and battery for re-assembly.
Page 23 For details on battery re-charging please refer to Section 3.2.3 of this User Manual. If you suspect a fault with your Shimmer battery, please refer to the troubleshooting section of this manual.
Page 24 Note: The Shimmer is not compatible with SDHC cards. 3.1.6. Internal Connector The expansion connector is on the top side of the Shimmer and consists of both J6 and J7, as shown in Figure 3-2. It is used to connect to internal daughter boards. All expansions will include appropriate enclosures.
Page 25: Shimmer Dock
For further hardware based information on the External connector please refer to Appendix A - Mainboard detail for Debug and Testing. 3.2. Shimmer Dock The Shimmer Dock (referred to as the Dock in this section) is a multi-purpose device which can provide three primary functions, as described in more detail throughout this section: ...
Page 26 FTDI Chip Drivers webpage. Download and install the driver to match your operating system. 2. Plug in your Shimmer USB Dock or USB reader. If the reader hasn't been powered recently, you may get a driver error. Simply unplug and try again.
Page 27 FTDI. Then, under the Advanced tab, make sure the Load VCP checkbox is ticked (see Figure 3-5). If the checkbox isn't ticked, you will need to tick for each Serial converter and then unplug and re-insert the dock.
Page 28 Next, under the Ports (COM & LPT) entry in the Device Manager, you should see two new USB Serial Port entries, each with an associated COM port number, as shown in Figure 3-6. The USB Serial Port with the lowest number is the Programming Port.
Page 29 When the Shimmer is placed in the dock, the green LED on the Power/Reset button on the dock will light up green if the Shimmer is powered on. If it does not light up, one of the following may have occurred: ...
Page 30 During this phase, the charge indicator LED on the Dock will illuminate yellow/orange. Phase 3 is the Conditioning Phase. The charger will continue to condition the battery as long as the Shimmer remains inserted in the charger. For maximum operating life, it is advisable to allow as much conditioning time as your needs allow.
Page 31: Consensys Base
(see Consensys in section 4.1 for further information), for the simple and effective management of all your Shimmer data. The Base allows users to easily configure and capture data from up to 15 Shimmers simultaneously and provides ability to: ...
Page 32: Other Accessories And Shimmer Platform Components
A copy of each user guide can be obtained from the folder \Documentation\Hardware User Guides in the Shimmer User Resources distribution or by downloading it from the Shimmer website.
Page 33 Please refer to the Shimmer website for more information about new releases. 3.4.2. Multi Charger The primary function of the Multi Charger (see Figure 3-11) is to allow for the simultaneous charging of up to six Shimmers. The Multi Charger also has a Reset Button which allows for synchronised reset of multiple Shimmers.
Page 34: Maintenance
To use the Shimmer3 Calibration Stand, simply remove the strap clips from the Shimmer3 and insert the device into the stand using the clip slots, as shown in Figure 3-13. Ensure that the plastic clip inserts on the stand are securely inserted into the Shimmer3 clip slots and that that user button is facing upwards, as illustrated.
Page 35 The external connector should be swabbed with a fine brush. If you are using Shimmer in the presence of biohazards, treatment with a disposable wrap or cover is required according to best practices. Biohazard contamination will void warranty and contaminated devices returned to Realtime Technologies or any Shimmer address will be disposed of in accordance with applicable laws.
Page 36 3.5.4. Disposal Warning: Never expose Shimmer devices to excessive heat or an open flame. Shimmer devices should be disposed of like other rechargeable devices. They should never be thrown away in the trash without first removing the battery. Lithium-Ion/Polymer batteries are classified as hazardous substances in most municipalities and should be disposed of according to local law or practice.
Page 37: Software
 Development tools - provided to customers who wish to develop their own software applications. The sections below provide high level overviews of both Shimmer Software Applications and Software Development tools. 4.1. Software Applications This section provides a brief introduction to the suite of Shimmer Software Applications.
Page 38 Single Shimmer management. b) Basic visualisation of data that is streamed over Bluetooth from one Shimmer to the PC. c) Recording data that are streamed over Bluetooth from a single Shimmer to the PC into a database. d) Importing data recorded onto the microSD card of a single Shimmer into a database.
Page 39 4.1.2. Software for Streaming Data over Bluetooth Consensys Consensys (see Figure 4-1) allows users to display and record data received from Shimmer devices streaming over Bluetooth (using LogAndStream firmware v0.8.0 or later). See section 4.1.1 for Consensys overview. Currently, Consensys is only supported on the Windows platform.
Page 40 ShimmerCapture for Android ShimmerCapture for Android (Figure 4-3) is a mobile-device based application which allows users to configure a single Shimmer unit to stream data to an Android device over Bluetooth and save the data to file. The application is ideal for entry level users looking for quick-start application to visualise and store...
Page 41 Multi Shimmer Sync (MSS) for Android (Figure 4-4) is a mobile-device based application which allows users to configure multiple Shimmer units to stream data to an Android device over Bluetooth, as well as saving the time-synchronised data to a file.
Page 42 (Figure 4-6) applications provide an automated procedure for calculating the calibration parameters for Shimmer’s integrated tri-axial accelerometer, gyroscope and magnetometer. The calibration parameters can be stored to the Shimmer on-board memory or to a file and can be recalled by other applications to provide calibrated sensor data.
Page 44: Software Development
Shimmer Instrument Drivers (Shimmer IDs) and Shimmer Application Programming Interfaces (Shimmer APIs). The Shimmer IDs and APIs are libraries for software developers that allow for the rapid integration of the Shimmer platform into software applications being developed in C#, LabVIEW, MATLAB and Java/Android.
Page 45 All rights reserved Rev3p Shimmer users will benefit from MATLAB’s full range of tools including matrix manipulations, plotting of functions and data, implementation of algorithms, creation of user interfaces, and interfacing with programs written in other languages, including C, C++, Java, and Fortran. The code is...
Page 46: Firmware
The source code is also openly available for any able user who may wish to modify or customise it to their own needs or, indeed, to use it as the basis for a new firmware application; see Section 5.3 for more details and resources for developing firmware.
Page 47 Copyright © Shimmer 2017 Realtime Technologies Ltd Shimmer User Manual All rights reserved Rev3p A Shimmer3 programmed with LogAndStream firmware can be in one of five states: Idle, BT Connected, BT Streaming, BT Streaming + SD Logging or just SD Logging - as shown in Figure 5-1. The...
Page 48 Copyright © Shimmer 2017 Realtime Technologies Ltd Shimmer User Manual All rights reserved Rev3p LED Pattern Description Standby Blue 0.1s ON/2s OFF Bluetooth Blue Solid ON Connected Streaming only Blue 1s ON / 1s OFF RTC not set 0.1s Blue/0.1s Green Configuring Green 0.1s ON/ 0.1s OFF...
Page 49 1-bit SPI mode. The Shimmer3 is shipped with a compatible microSD card. A Shimmer Dock or Consensys Base is required to allow access the SD card on the Shimmer from the PC for configuration of logging preferences and data transfer. Please note that legacy (black) Shimmer docks are not suitable for this purpose and a newer (white) dock is required.
Page 50 SD and RTC errors into a 0.1s Blue/0.1s Green LED flashing sequence. Note: The Shimmer should never be placed in the Dock while the operation status LED’s indicate that it is configuring as this may cause a file-system error. Once configuration has begun, you must...
Page 51: Programming A Shimmer
All rights reserved Rev3p Note: Placing the Shimmer in the Dock while it is logging data is not recommended as this can cause SD card access problems. Make sure that logging has stopped before docking the device. Note: Logging and other SD card related operations are not carried out while the device is on the dock.
Page 52 Programming firmware onto a Shimmer using Consensys is a four step process: 1. Launch Consensys and select the MANAGE DEVICES tab. 2. Insert your Shimmer (ensure it’s powered on) into a Dock or Consensys Base; select the Shimmer from table or from the...
Page 53 "/dev/ttyUSB0" – change as necessary): python -m msp430.bsl5.uart --invert-test --invert-reset -p /dev/ttyUSB0 -r -e -i titext -P S3_Blink.txt 6. Remove the Shimmer3 from the Shimmer Dock and cycle the power to reset and run the freshly loaded firmware.
Page 54: Firmware Development
5.3.2. Getting and updating the Shimmer source code All Shimmer source code is hosted in a Github repository. Git is an open source version control system that facilitates software configuration management. It is used by many software developers to manage changes within their source code tree and provides the means to store the current version of a source code element (e.g.
Page 55 1. With the project selected in Code Composer Studio, go to the "Project" menu and select "Properties". 2. As shown in Figure 5-3, select the "Build" menu in the left panel and then select the "Steps" panel on the right.
Page 56: Hardware
Proto 3 Deluxe. The external expansion also allows communication to and from the mainboard using the docking station. The Shimmer board has a built in microSD Flash socket for additional storage and has five light- emitting diodes (LED) for display purposes. It also has an on-off switch and a software-defined user button.
Page 57 Shimmer. 6.2.1. Radio Communication One of the key functions of the Shimmer board is its ability to communicate as a wireless platform. Shimmer uses a Bluetooth Radio module. Bluetooth (IEEE 802.15.1)
Page 58 6.2.3. Power The Shimmer units are supplied with a 3.7V 450mAh re-chargeable Lithium battery but the design supports both Lithium-Ion/Lithium-Poly cell chemistry and lithium coin cells and alkaline batteries. Device safety is maintained by integrating battery polarity protection, charge monitoring and failsafe battery over/under voltage and over-discharge limits in common mobile environments and while AC-powered.
Page 59 All rights reserved Rev3p Shimmer’s on-board regulator can provide 100mA continuous current and tolerates surges until a thermal limit is reached. Expansion devices must be current limited or have independent regulation running off the PV_REG expansion pin. Exceeding the 100mA limit of the regulator, whilst possible, is not recommended without detailed analysis and qualification of both electrical and thermal design margin.
Page 60 = 0, Vref=3V, gain = 1. Equation 2 In order to estimate the remaining battery capacity you can use Table 6-3 which has been derived from information provided by the battery manufacturer. Note that the number of charge cycles a...
Page 61 Copyright © Shimmer 2017 Realtime Technologies Ltd Shimmer User Manual All rights reserved Rev3p battery has undergone in its lifetime will influence the accuracy of the remaining capacity estimates. According to the battery manufacturer the worst case is 75% of full capacity after 300 cycles.
Page 62: Troubleshoot
Verify Shimmer is within range of host side device and has a line of sight. o Whilst the Shimmer BT radio has a range of 10m, the range of your host side BT radio may vary and should be verified. Bluetooth communication doesn't necessarily require line of sight;...
Page 63 If you experience difficulties accessing the microSD card, please consult the Troubleshooting section of the Shimmer Dock User Guide (v1.5 or later) which can be obtained from the folder \Documentation\Hardware User Guides in the Shimmer User Resources distribution or from our website.
Page 64: References
Copyright © Shimmer 2017 Realtime Technologies Ltd Shimmer User Manual All rights reserved Rev3p 8. References Bluetooth Special Interest Group, Serial port Profile Specification, Vol. 7 Part B of the Bluetooth Specification Version 2, November, 2004. C. Hodgdon, Adaptive frequency hopping for reduced interference between Bluetooth and wireless LAN, Ericsson Technology Licensing, May 2003.
Page 65: Appendices
These following components may be removed or replaced to support specific user applications, configure the board or perform power-measurement testing. Figure 9-1 and Figure 9-2 provide illustrations of the Shimmer3 mainboard layout with each component labelled appropriately. For more information, contact Shimmer support. Negative battery terminal Positive battery terminal...
Page 68 (JTAG_TDO) (JTAG TDO Signal) J5-16 ADC15_RADIO_DC ADC Input. Alternate function is reserved for coprocessor Bi-Spy Wire J5-17 Regulated Board power output: 3.0VDC @ 100ma* J5-18 Board Ground Board Ground TABS/SHELL Table 9-1 External Expansion Connecor Pin Assignment * Exact current capacity will vary based on operating state of integrated peripherals and processor.
Page 69 J7,10 J6-11 J7-11 J6-12 J7-12 J6-TABS J7-TABS Table 9-2 Internal Expansion Connector Pin Assignment 9.1.3. CPU Pin Assignment The CPU pin connections for Shimmer developers are listed below: Pin Name Pin # Board Name Type DVCC 16,51,31,67 PV_MSP Power Analogue...
Page 70 Copyright © Shimmer 2017 Realtime Technologies Ltd Shimmer User Manual All rights reserved Rev3p P1.4 GPIO_INTERNAL Input (IRQ) P1.5 GPIO_EXTERNAL_RADIO_DD TBD, RADIO EXP Input (IRQ) P1.6 USER_N User Button Input (IRQ) P1.7 MPU_INT Kinematics Input(IRQ) P2.0 GPIO_EXTERNAL1 Expansion Input (IRQ) P2.1...
Page 71: Appendix B - Legacy Support
2. Turn the unit over so that the button is facing up. 3. Carefully remove the top of the case, opening from the end of the dock connector. 4. You now have access to the SD card slot and the internal expansion connector.
Page 72 2. Assemble the orange clip fittings in the bottom of the enclosure (these are both the same so it doesn’t matter which one goes to which side). 3. Install the power switch cap, as shown in Figure 9-6. 4. Place the circuit board, with the battery attached to the underside, into the bottom of the enclosure, as shown in Figure 9-7.
Page 73 Copyright © Shimmer 2017 Realtime Technologies Ltd Shimmer User Manual All rights reserved Rev3p o Note: it is very important to hold the boss ends together while running in the screw. Do not let the screws draw the parts together as this could damage the enclosure.
Page 75: Glossary
Copyright © Shimmer 2017 Realtime Technologies Ltd Shimmer User Manual All rights reserved Rev3p Glossary ACLK Auxiliary Clock Analogue-to-Digital Converter Boot Strap Loader Bluetooth Central Processing Unit CSMA Carrier Sense Multiple Access Concurrent Versioning System Digitally Controlled Oscillator Direct Memory Access...

Shimmer 3 User Manual

Quick Links

Need help?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Shimmer 3

Summary of Contents for Shimmer 3