glassboard-dev / mcp342x Goto Github PK

It would be nice to grab usr functions from a BSP folder that are ready to use for a developers micro

The driver will follow the javadoc method of documenting the source and API

The final IF statement does an assignment instead of a comparison..

mcp342x_return_code_t mcp342x_writeConfig(mcp342x_dev_t *dev) {
    mcp342x_return_code_t ret = MCP342x_RET_OK;

    if( dev == NULL ) {
        // The pointer to the mcp342x dev is NULL
        ret = MCP342x_RET_NULL_PTR;
    }

    if( (dev->registers.bits.config.bits.conv_mode >= MCP342x_CM__MAX__) ||
        (dev->registers.bits.config.bits.gain >= MCP342x_GAIN__MAX__) ||
        (dev->registers.bits.config.bits.sample_rate >= MCP342x_SR__MAX__) ) {
        // One of the config values provideed to use is not valid.
        ret = MCP342x_RET_INV_PARAM;
    }

    if( ret = MCP342x_RET_OK ) {
        // Write the config to our device
        ret = dev->intf.write((dev->intf.i2c_addr << 1), &dev->registers.bits.config.byte, 0x01);
    }

    return ret;
}

The current source is built around using STM HAL I2c calls. We want these to be abstracted away through function pointers, as well as adding the ability to instantiate multiple entities of the driver if a developer has several ADC chips.

The API currently allows a user to sample any channel they want. In the future, it would be nice to have an API to retrieve samples from all enabled config. Offloading the work to sample multiple channels from the app to the driver.

The results are to be stored in an array, and currently they are placed at the address of the array itself and not the proper index.

The ADC sample channel function currently retries 10 times when sampling a channel. Add a configuration option to set the amount of retries that should be attempted.

When making the submodules public, we need to place a license on the source before releasing.