Git Product home page Git Product logo

arduino_core_stm32's Introduction

Arduino core support for STM32L082-based boards

This repository is MCCI's version of Arduino_Core_STM32, adapted for the STM32L082. The BSP here targets the STM32L082 as used in the Murata CMWX1ZZABZ LoRa® module, as further in the MCCI Catena® LoRaWAN® technology boards. Several of these boards are closely compatible with the Adafruit Feather M0 LoRa. See Supported Boards and CPUs for more info.

For general information, please check the stm32duino README.md, especially the Getting Started section.

GitHub release GitHub commits

Contents:

Getting Started

This repository is available as a package usable with the Arduino Boards Manager. Add this URL to "Additional Boards Manager URLs" under File>Preferences:

https://github.com/mcci-catena/arduino-boards/raw/master/BoardManagerFiles/package_mcci_index.json

For full instructions on using the "Boards Manager", see Installing the MCCI Catena BSP.

Features

The Arduino IDE allows you to select the following items.

  • LoRaWAN Region: when using the Arduino LMIC, you can select North America, Europe, Australia, Asia-923, Japan, Korea, or India as your target region.
  • Optimization: choose smallest, fast, faster, fastest, or debug.
  • Serial interface: Select "USB Serial", "Generic Serial" or "No Serial".
  • System clock: Select "32 MHz (most power)", "24 MHz", "16 MHz", "4.194 MHz (no USB)" or "2.097 MHz (no USB, least power)". If "2.097 MHz (no USB, least power)" or "4.194 MHz (no USB)" is selected, then you cannot use "USB Serial" for serial interface.
  • Upload method: select Mass Storage, DFU, or STLink. DFU works well, but requires use of the boot jumper to select DFU mode, and a little driver wrangling on Windows.

Supported Boards and CPUs

Board CPU/SOC/Module Section Comment
MCCI Catena 4551 Murata CMWX1ZZABZ module, STM32L082 461x Obsolete
MCCI Catena 4610 Murata CMWX1ZZABZ module, STM32L082 461x LiPo battery
MCCI Catena 4611 Murata CMWX1ZZABZ module, STM32L082 461x Special order only
MCCI Catena 4612 Murata CMWX1ZZABZ module, STM32L082 461x Primary battery, BME280
MCCI Catena 4617 Murata CMWX1ZZABZ module, STM32L082 461x Primary battery, HS3001
MCCI Catena 4618 Murata CMWX1ZZABZ module, STM32L082 461x Primary battery, SHT31-DIS-F
MCCI Catena 4630 Murata CMWX1ZZABZ module, STM32L082 4630 LiPo battery,ZMOD4410, PMS7003
MCCI Catena 4801 Murata CMWX1ZZABZ module, STM32L082 4801 Primary battery, Modbus

Catena 461x Series

Feature 4551 4610 4611 4612 / 4617 / 4618
TCXO control Always on (power consumption issue) Controlled by code Controlled by code Controlled by code
Battery type Primary (non-rechargeable) reference is 2x AAA cells Secondary (LiPo rechargeable), compatible with Adafruit Feather batteries Primary (non-rechargeable) reference is 2x AAA cells
System voltage 3.3V 3.3V 3.3V 2.2V to 3.3V, depending on whether boost regulator is enabled.
Regulator control EN pin on Feather disables VDD altogether No boost regulator; EN disables VDD altogether. EN pin on JP2-3 shuts down boost regulator EN output from CPU controls boost regulator. 4612/4617/4618 normally run with boost regulator off for lower power.
High-side switch for external sensors No switch, screw terminal power is from VDD (3.3V) High-side switch allows software to turn off power to the external sensor screw terminals High-side switch allows software to turn off power to the external sensor screw terminals High-side switch allows software to turn off power to the external sensor screw terminals
Feather electrical compatibility Good, except for different battery system Very good Very good Good physical compatibility but the varying VDD may be an issue
Feather physical compatibility Yes Yes Yes Yes
USB Supported Supported Supported Supported
Sensors BME280, Si1123 BME280, Si1113 BME280, Si1113 See Catena 4612/7/8 Sensors, below
Screw terminals for external sensors 2x4 pin 2x4 pin 2x4 pin 2x4 pin
Boot mode enable Jumper Dedicated switch Jumper Jumper

Sensors on Catena 4612, 4617, and 4618

All three boards incorporate a Silicon Labs Si1133 ambient light sensor. They differ in the environmental sensor.

Board Sensor Temperature Humidity Barometric Pressure Comments
4612 BME280 Yes Yes Yes Not suitable for outdoor applications or high-humidity environments.
4617 HS3001 Yes Yes No Suitable for general-purpose use.
4618 SHT31-DIS-F Yes Yes No Sensor protected by an IP66 PTFE membrane, best for outdoor deployments.

Catena 4630 Features

The 4630 is a Feather-compatible board designed for field air-quality monitoring.

Feature 4630
TCXO Control Controlled by code
Battery type LiPo with on-board charger
System voltage 3.3V, plus programmable 5V regulator for PMS7003 PM2.5 sensor support.
Regulator control No boost regulator for 3.3V; EN disables VDD altogether. D12 controls 5V boost regulator for PMS7003.
High-side switch for power for external sensors No
Screw terminals for external sensors None
Feather electrical compatibility Yes
Feather physical compatibility Yes
USB Yes, DFU download, runtime data, and charging
Sensors ZMOD4410 VOC sensor; BME280 temperature/pressure/humidity
External interfaces TTL Serial, dedicated cable for connecting to PMS7003 PM2.5 sensor

Catena 4801 Features

The 4801 is a dedicated board for remote Modbus applications, using the Murata module.

Feature 4801
TCXO Control Controlled by code
Battery type Primary battery, boost regulator (but can tolerate up to 3.7V battery)
System voltage 2.2V to 3.3V, depending on whether boost regulator is enabled.
Regulator control EN output from CPU controls boost regulator, and 4801 normally runs with boost regulator off for lower power.
High-side switch for power for external sensors Yes
Screw terminals for external sensors 1x4 pin
Feather physical compatibility No
USB Not supported
Sensors none
External interfaces Modbus, TTL serial

Troubleshooting

If you have any issue, you may file an issue on GitHub. You may also submit a support request on the MCCI support forum.

Installing a Development Copy of this BSP

If you want to develop and test changes to this package, we suggest the following.

  1. Install the current release from the standard location using the Arduino Tools>Boards>Boards Manager... menu. This installs tools and so forth.

  2. Select a board supported by this package.

  3. Create an empty sketch with Arduino File>New, and check that you can build.

  4. Close the Arduino IDE.

  5. Clone this repo to a convenient spot on your computer.

  6. Open a command window and go to the Arduino board installation directory. It will be one of the following.

    System Location
    Windows 7 through 10 c:\Users\username\AppData\Local\Arduino15. If you're using git bash, you can also use ~/AppData/Local/Arduino15
    macOS ~/Library/Arduino15
    Linux ~/.arduino15
  7. From this location, change directory to packages/mcci/stm32.

  8. Look at the directory contents with ls. You'll see a directory named like a version number, for example 1.0.8.

  9. Move the directory you just found away from the stm32 directory. It's convenient to have it around, so we suggest that you not delete it.

  10. Create a symbolic link to the sandbox you created in step (3) above. On macOS and Linux, this is done using the ln -s command. On Windows 10, this is done with the mklink /d command. (On older versions of Windows, unless you're very experienced, you might want to use a Linux VM in VirtualBox -- we can't advise on the best way to do this.)

  11. Open the Arduino IDE.

  12. Use the menu File>New to create an empty sketch (or reuse the sketch from step 3).

  13. Make sure the board you want to develop for is selected in Tools>Boards.

  14. Make changes and build.

Remember to restart the IDE whenever you change platform.txt, boards.txt or programmers.txt.

Release History

  • v2.6.0 adds support for KR-920 (Korea 920 MHz) in the region selection menu (#117). Adds official library.properties fields for linking pre-compiled object and adds additional pins definitions for SX1276 radios (#128) (thanks to Kent Williams). Add source-level debugging support (#122). Adjust USB Vbus check values for Catena 461x platform. Define AU915 as well as AU921 for LMIC migration (#131). Fix link "warning: changing start of section .bss by 4 bytes" (#129). Update issue template.

  • v2.5.0 enables the crystal controlled LSE clock, and uses it to run the RTC. Code was substantially refactored to move common code to common directories. Bug fixes.

  • v2.4.0 Added support for new boards: 4617, 4618 and 4630. Serial interface configuration in boards.template has been updated with new option to use both USB Serial and Hardware Serial at same time.

  • v2.3.0 corrects the handling of clocking in the various SLEEP/STOP/SSTANDBY modes. It also ensures that .RamFunc code is properly placed in RAM (initialzed when statics are initialized).

  • v2.2.1 fixed the version number in platform.txt, and sets GPIO to reset state when de-initializing SPI, I2C and UARTs.

  • v2.2.0 increases the serial buffer size to 256 and adds low-power changes for the Catena 4801.

  • v2.1.0 fixed the device ID register offset, and improved sleep mode power.

  • v2.0.0 is a major release. It improves wakeup support and power management, and simplifies some of the menus. New boards: 4610 and 4801. The template system was enhanced. USB manufacturer string is no longer "unknown". Changed hardware serial default baud rate to 115,200 from 9600. Moved USB clock control to USB module. Enhanced begin()/end() for USB and I2C to start/stop clocks. (This is a major bump beause the baud rate change may be a breaking change.)

  • v1.1.2 added 4611, 4612 support, and templating for generating boards.txt.

Notes and Acknowledgements

MCCI and MCCI Catena are registered trademarks of MCCI Corporation. ChaeHee Won, Sungjoon Park, and Terry Moore of MCCI maintain this BSP.

LoRa is a registered trademark of the LoRa Alliance. LoRaWAN is a registered trademark of the LoRa Alliance.

All other trademarks are the property of their respective owners.

Support Open-Source Software, Hardware, and Community IoT

Everyone at MCCI invests time and resources providing this open-source code and open-source hardware. MCCI is also the principal corporate sponsor of The Things Network New York and Ithaca. Please support our work by purchasing products from MCCI! Visit our on-line store at store.mcci.com.

arduino_core_stm32's People

Contributors

adminius avatar chwon64 avatar cparata avatar damien16130 avatar dhineshkumarmcci avatar fpistm avatar kent-williams avatar knielsen avatar lacklustrlabs avatar prabin31 avatar rickkimball avatar silviooliva avatar sjpark-mcci avatar straccio avatar svelmurugan92 avatar terrillmoore avatar tomvdb avatar troth avatar vvestm avatar xloem avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.