Intermediate
30 min
0

Accurately measure and analyze the magnitude of earthquakes with D7S and PIC18F25J50

Measuring Earth's fury

Earthquake click with EasyPIC v7

Published Nov 01, 2023

Click board™

Earthquake click

Development board

EasyPIC v7

Compiler

NECTO Studio

MCU

PIC18F25J50

This solution provides crucial data that aids in understanding and quantifying the seismic activity of our planet

A

A

Hardware Overview

How does it work?

Earthquake Click is based on the D7S, the world’s smallest class-size high-precision seismic sensor from Omron. It uses the SI (spectral intensity) value, which has a high correlation with the seismic intensity scale that indicates the magnitude of an earthquake and provides higher-precision judgment of seismic intensity scales. When an earthquake occurs with a seismic intensity equivalent to 5 Upper or higher on the JMA (Japan Meteorological Agency) Seismic Intensity Scale, the D7S will activate the shutoff output to notify the user of an earthquake. JMA, or

Japan Meteorological Agency Intensity Scale, is used in Japan and Taiwan to measure the intensity of earthquakes. The scale goes from 0 to 7. Level 5 on this scale indicates when objects inside a house start falling, like books from the shelf, dishes in a cupboard, cracks formed on walls, and more. Earthquake Click uses a standard 2-Wire I2C interface to communicate with the host MCU. The shutoff terminal on IN1 will go active (ON) when the shutoff judgment condition and collapse detection condition are met. The processing notification output IN2 will go active (ON) during

the earthquake calculations, offset acquisition, and self-diagnostic processing. The initial setting input ST changes the sensor from Normal mode to Initial Installation mode for input from an external device. This Click board™ can operate with either 3.3V or 5V logic voltage levels selected via the 3.3V 5V jumper. This way, both 3.3V and 5V capable MCUs can use the communication lines properly. However, the Click board™ comes equipped with a library containing easy-to-use functions and an example code that can be used as a reference for further development.

Earthquake Click top side image
Earthquake Click bottom side image

Features overview

Development board

EasyPIC v7 is the seventh generation of PIC development boards specially designed to develop embedded applications rapidly. It supports a wide range of 8-bit PIC microcontrollers from Microchip and has a broad set of unique functions, such as a powerful onboard mikroProg programmer and In-Circuit debugger over USB-B. The development board is well organized and designed so that the end-user has all the necessary elements in one place, such as switches, buttons, indicators, connectors, and others. With four different connectors for each port, EasyPIC v7 allows you to connect accessory boards, sensors, and custom electronics more efficiently than ever. Each part of

the EasyPIC v7 development board contains the components necessary for the most efficient operation of the same board. An integrated mikroProg, a fast USB 2.0 programmer with mikroICD hardware In-Circuit Debugger, offers many valuable programming/debugging options and seamless integration with the Mikroe software environment. Besides it also includes a clean and regulated power supply block for the development board. It can use various external power sources, including an external 12V power supply, 7-23V AC or 9-32V DC via DC connector/screw terminals, and a power source via the USB Type-B (USB-B) connector. Communication options such as

USB-UART and RS-232 are also included, alongside the well-established mikroBUS™ standard, three display options (7-segment, graphical, and character-based LCD), and several different DIP sockets. These sockets cover a wide range of 8-bit PIC MCUs, from PIC10F, PIC12F, PIC16F, PIC16Enh, PIC18F, PIC18FJ, and PIC18FK families. EasyPIC v7 is an integral part of the Mikroe ecosystem for rapid development. Natively supported by Mikroe software tools, it covers many aspects of prototyping and development thanks to a considerable number of different Click boards™ (over a thousand boards), the number of which is growing every day.

EasyPIC v7 horizontal image

Microcontroller Overview

MCU Card / MCU

default

Architecture

PIC

MCU Memory (KB)

32

Silicon Vendor

Microchip

Pin count

28

RAM (Bytes)

3800

Used MCU Pins

mikroBUS™ mapper

NC
NC
AN
NC
NC
RST
Initial Setting Input
RA5
CS
NC
NC
SCK
NC
NC
MISO
NC
NC
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
Processing Notification Interrupt
RC1
PWM
Shutoff Interrupt
RB1
INT
NC
NC
TX
NC
NC
RX
I2C Clock
RC3
SCL
I2C Data
RC4
SDA
Power Supply
5V
5V
Ground
GND
GND
2

Take a closer look

Schematic

Earthquake click Schematic schematic

Step by step

Project assembly

EasyPIC v7 front image hardware assembly

Start by selecting your development board and Click board™. Begin with the EasyPIC v7 as your development board.

EasyPIC v7 front image hardware assembly
Rotary B 2 Click front image hardware assembly
MCU DIP 28 hardware assembly
EasyPIC v7 MB 2 - upright/background hardware assembly
Necto image step 2 hardware assembly
Necto image step 3 hardware assembly
Necto image step 4 hardware assembly
NECTO Compiler Selection Step Image hardware assembly
NECTO Output Selection Step Image hardware assembly
Necto image step 6 hardware assembly
Necto DIP image step 7 hardware assembly
EasyPIC PRO v7a Display Selection Necto Step hardware assembly
Necto image step 9 hardware assembly
Necto image step 10 hardware assembly
Necto PreFlash Image hardware assembly

Track your results in real time

Application Output

After pressing the "FLASH" button on the left-side panel, it is necessary to open the UART terminal to display the achieved results. By clicking on the Tools icon in the right-hand panel, multiple different functions are displayed, among which is the UART Terminal. Click on the offered "UART Terminal" icon.

UART Application Output Step 1

Once the UART terminal is opened, the window takes on a new form. At the top of the tab are two buttons, one for adjusting the parameters of the UART terminal and the other for connecting the UART terminal. The tab's lower part is reserved for displaying the achieved results. Before connecting, the terminal has a Disconnected status, indicating that the terminal is not yet active. Before connecting, it is necessary to check the set parameters of the UART terminal. Click on the "OPTIONS" button.

UART Application Output Step 2

In the newly opened UART Terminal Options field, we check if the terminal settings are correct, such as the set port and the Baud rate of UART communication. If the data is not displayed properly, it is possible that the Baud rate value is not set correctly and needs to be adjusted to 115200. If all the parameters are set correctly, click on "CONFIGURE".

UART Application Output Step 3

The next step is to click on the "CONNECT" button, after which the terminal status changes from Disconnected to Connected in green, and the data is displayed in the Received data field.

UART Application Output Step 4

Software Support

Library Description

This library contains API for Earthquake Click driver.

Key functions:

  • earthquake_proc_notify - Shutoff output function

  • earthquake_read_status - Read status function

  • earthquake_read_si - Read SI function

Open Source

Code example

This example can be found in NECTO Studio. Feel free to download the code, or you can copy the code below.

/*!
 * \file 
 * \brief Earthquake Click example
 * 
 * # Description
 * Intializes I2C module, LOG and GPIO structure, sets INT and PWM pins as 
 * input and sets CS pin as output.
 *
 * The demo application is composed of two sections :
 * 
 * ## Application Init 
 * Intializes of I2C driver and makes initial log.
 * 
 * ## Application Task  
 * This is an example that shows most of the functions that Earthquake click
 * has. Results are being sent to the Usart Terminal where you can track their 
 * changes.
 * 
 * 
 * \author MikroE Team
 *
 */
// ------------------------------------------------------------------- INCLUDES

#include "board.h"
#include "log.h"
#include "earthquake.h"

// ------------------------------------------------------------------ VARIABLES

static earthquake_t earthquake;
static log_t logger;
uint16_t read_data;
uint8_t cnt;

void display_status( uint8_t status_data )
{
    if ( status_data == EARTHQUAKE_STANDBY_MODE )
    {
        log_printf( &logger, "Standby  Mode \r\n" );
    }

    if ( status_data == EARTHQUAKE_NORMAL_MODE )
    {
        log_printf( &logger, "Normal Mode \r\n" );
    }
    
    if ( status_data == EARTHQUAKE_INIT_INST )
    {
        log_printf( &logger, "Initial Installation Mode \r\n" );
    }
    
    if ( status_data == EARTHQUAKE_OFFSET_ACQ )
    {
        log_printf( &logger, "Offset Acquisition Mode \r\n" );
    }
    
    if ( status_data == EARTHQUAKE_SELF_DIAGNOSTIC )
    {
        log_printf( &logger, "Self-Diagnostic Mode \r\n" );
    }
}

void application_init ( void )
{
    log_cfg_t log_cfg;
    earthquake_cfg_t cfg;

    /** 
     * Logger initialization.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_info( &logger, "---- Application Init ----" );

    //  Click initialization.

    earthquake_cfg_setup( &cfg );
    EARTHQUAKE_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    earthquake_init( &earthquake, &cfg );

    Delay_ms( 100 );

    log_printf( &logger, "------------------------\r\n" );
    log_printf( &logger, "    Earthquake Click    \r\n" );
    log_printf( &logger, "------------------------\r\n" );
}

void application_task ( void )
{
    if ( earthquake_proc_notify( &earthquake ) )
    {
        log_printf( &logger, "  Earthquake detected!  \r\n" );
        log_printf( &logger, "------------------------\r\n" );
        Delay_ms ( 2000 );

        for ( cnt = 20; cnt > 0; cnt-- )
        {
            log_printf( &logger, " Status : " );
            display_status( earthquake_read_status( &earthquake ) );

            read_data = earthquake_read_si( &earthquake );
            log_printf( &logger, " Max SI : %5d\r\n", read_data );
            log_printf( &logger, "------------------------ \r\n" );
            Delay_ms( 5000 );
        }

        earthquake_clear_mememory( &earthquake );
        log_printf( &logger, " Afterquake  processing \r\n" );
        log_printf( &logger, "     please wait...     \r\n" );
        Delay_ms( 20000 );

        log_printf( &logger, "------------------------\r\n" );
        log_printf( &logger, " Waiting for a quake... \r\n" );
        log_printf( &logger, "------------------------\r\n" );
    }
}

void main ( void )
{
    application_init( );

    for ( ; ; )
    {
        application_task( );
    }
}


// ------------------------------------------------------------------------ END

Additional Support

Resources