Quickstart guide for MCP980X module

This is the quickstart guide for the MCP980X module, with step-by-step instructions on how to configure and use the drivers in a selection of use cases.

The use cases contain several code fragments. The code fragments in the steps for setup can be copied into a custom initialization function, while the steps for usage can be copied into, e.g., the main application function.

Basic use case

In this basic use case, the MCP980X module is configured to:

• Disable ONE-SHOT mode
• 12-bit temperature sensor accuracy
• 2 fault queue cycles
• Active-high alert polarity
• Alert output in interrupt mode
• Disable shutdown mode

Setup steps

Prerequisites

• Two-Wire Interface service(TWI)

Example code

Add this MCP980X initialization code at the beginning of the main function:

mcp980x_init();

mcp980x_set_configuration(
        MCP980X_CONFIG_RESOLUTION_12_BIT          |
        MCP980X_CONFIG_FAULT_QUEUE_2              |
        MCP980X_CONFIG_ALERT_POLARITY_ACTIVE_HIGH |
        MCP980X_CONFIG_INTERRUPT_MODE);

mcp980x_set_temperature_limit(TEMP_LIMIT_MAX, TEMP_LIMIT_DEC);

mcp980x_set_temperature_hysteresis(TEMP_LIMIT_MIN, TEMP_LIMIT_DEC);

Workflow

1. Initialize MCP980X driver:

   • mcp980x_init(); 

2. Set MCP980X configuration:

   • mcp980x_set_configuration(
        MCP980X_CONFIG_RESOLUTION_12_BIT          |
        MCP980X_CONFIG_FAULT_QUEUE_2              |
        MCP980X_CONFIG_ALERT_POLARITY_ACTIVE_HIGH |
        MCP980X_CONFIG_INTERRUPT_MODE); 

3. Set temperature limit:

   • mcp980x_set_temperature_limit(TEMP_LIMIT_MAX, TEMP_LIMIT_DEC); 

4. Set temperature hysteresis:

   • mcp980x_set_temperature_hysteresis(TEMP_LIMIT_MIN, TEMP_LIMIT_DEC);

Usage steps

Example code

Add to, e.g., main loop in application C-file:

mcp980x_one_shot_mode();
mcp980x_get_temperature(&temperature_int, &temperature_dec);

Workflow

1. Enable One-Shot mode to perform a single temperature measurement:

   • mcp980x_one_shot_mode(); 

2. Retrieve ambient temperature:

   • mcp980x_get_temperature(&temperature_int, &temperature_dec);