هدف ما از انجام این پروژه چیست؟
در این بخش قصد داریم سنسور ICM20948 را به وسیله میکروکنترلر آرم، سری STM32F راه اندازی کنیم. به منظور استفاده راحت تر و بهینه تر در این پروژه از دو ماژول آماده GB308IM و GebraBit STM32F303 استفاده میکنیم.
این دو ماژول شامل مینیمم قطعات لازم سنسور ICM20948و میکروکنترلر STM32F میباشند که توسط تیم جبرابیت جهت آسان سازی کار فراهم شده اند.
در این آموزش چه چیزهایی یاد میگیریم؟
شما در این بخش ضمن راه اندازی و استفاده از سنسورICM20948 ، به طور خلاصه با تمامی رجیسترهای سنسور ICM20948، نحوه تنظیم بخش های مختلف میکروکنترلر STM32 برای راه اندازی این سنسور با استفاده از پروتکل SPI، چگونگی استفاده از فایل کتابخانه و درایور مختص ماژول GB6308IM، نحوه فراخوانی توابع و در نهایت دریافت داده های سنسور در کامپایلر Keil نیز آشنا خواهید شد.
برای انجام این پروژه به چه چیزهایی نیاز داریم؟
همانطور که احتمالا میدانید برای انجام این پروژه به سخت افزارها و نرم افزارهایی نیاز داریم. عناوین این سخت افزارها و نرم افزارها در جدول زیر در اختیارتان قرار داده شده که میتوانید با کلیک روی هرکدام از آنها، آنها را تهیه/دانلود کنید و برای شروع آماده شوید.
|
سخت افزارهای مورد نیاز
|
نرم افزارهای مورد نیاز
|
|---|---|
|
Keil compiler
|
|
|
STM32CubeMX program
|
|
|
ST-LINK/V2 programmer
|
برای ارتباط از طریق پروتکل SPI ابتدا باید با استفاده از جامپرهای روی برد پروتکل ارتباطی SPI روی GebraBit ICM20948 انتخاب شود، سپس آن را به ماژول میکروکنترلر GebraBit STM32F303 متصل میکنیم.
توجه : تصویر بالا صرفا برای نمایش نحوه قرار گیری ماژول GebraBit ICM20948 بر روی ماژول GebraBit STM32F303 استفاده شده است . لذا برای استفاده از پروتکل ارتباطی SPI کاربر باید نسبت به انتخاب صحیح وضعیت جامپر های روی برد اقدام کند.
همچنین توجه داشته باشید که در اینجا صرفا برای درک بهتر ماژول GebraBit ICM20948 روی میکروکنترلر قرارداده شده است اما از آنجایی که سطح منطق ماژول GebraBit ICM20948 ، 1.8 ولت و سطح منطق ماژول میکروکنترلر GebraBit STM32F303 3V3 میباشد، طبق دیتاشیت کاربران باید از انجام این نوع اتصال خودداری نمایند. لذا لازم است سطح منطق دو ماژول را از طریق یک مبدل لاجیک لول، به یکدیگر تبدیل کنید.
در واقع نحوه صحیح اتصال ماژول GebraBit ICM20948 با ماژول میکروکنترلر GebraBit STM32F303 با استفاده از پروتکل SPI به صورت زیر میباشد.
در ورژن بعدی ماژول GebraBit ICM20948 ، این مسئله حل گردیده و کاربران میتوانند ورژن بعدی این ماژول را به راحتی به صورت Pin to Pin روی ماژول میکروکنترلر GebraBit STM32F303 “” قرار دهند.
در نهایت مقادیر دما و شتاب ، سرعت زاویه ای و میدان مغناطیسی را در سه محور X , Y , Z به صورت Real Time در پنجره Watch1 کامپایلر Keil در حالت Debug Session مشاهده خواهیم کرد.
تنظیمات STM32CubeMX
در ادامه تنظیمات مربوط به هریک از بخش های SPI , RCC , Debug , Clock را در میکروکنترلر STM32F303 برای راه اندازی ماژول GebraBit ICM20948 را مرور می کنیم.
تنظیمات RCC
در بخش RCC ، ” کلاک خارجی ” را انتخاب می کنیم زیرا یک کریستال 8 مگاهرتز در ماژول GebraBit STM32F30 وجود دارد.
تنظیمات Debug&Programming
با توجه به اینکه در ماژول GebraBit STM32F303 به پین‌های SWCLK و SWDIO دسترسی داریم ، برای کاهش تعداد پین هنگام Debug&Programming در بلوک “SYS” گزینه “Serial Wire” را در بخش Debug انتخاب می کنیم:
تنظیمات SPI
حال به منظور برقراری ارتباط SPI با ماژول GebraBit STM32F303 باید حالت “Full Duplex Master” را انتخاب کرده و پین های PB3 و PB4 و PB5 را به عنوان SCK و MISO و MOSI و پین PC13 را CS انتخاب کنیم :
با توجه به دیتاشیت سنسور ، تنظیمات پارامتر های SPI در بخش Parameter Settings همانند تصویر بالا مقدار دهی خواهد شد.
تنظیمات Clock
تنظیمات کلاک مربوط به هریک از بخش های میکروکنترلر STM32F303 در این کد به شرح ذیل می باشد:
تنظیمات Project Manager
تنظیمات Project Manager به صورت زیر بوده که در اینجا ما از کامپایلر MDK-ARM ورژن 5.32 استفاده کرده ایم:
بعد از اتمام تمام تنظیمات فوق ، بر روی GENERATE CODE کلیک کرده و با اضافه کردن کتابخانه و درایور(تهیه شده توسط GebraBit) ICM20948 ، کد خود را به راحتی توسعه می دهیم.فایل STM32CubeMX , کتابخانه و درایور و پروژه KEIL را می توانید از انتهای این آموزش دانلود کنید.
کتابخانه و درایور ICM20948
GebraBit علاوه بر طراحی ماژولار سنسورها و آی سی های مختلف ، پیشرو در ارائه انواع کتابخانه های ساختاریافته و مستقل از سخت افزار به زبان C، جهت سهولت کاربران در راه اندازی و توسعه نرم افزاری آنها نیز بوده است.
بدین منظور پس از تهیه هر یک از ماژول های GebraBit ، کاربر می تواند با مراجعه به بخش آموزش ماژول مربوطه، کتابخانه مختص به آن ماژول که حاوی فایل .h و .c (Header and Source) و یک برنامه نمونه آموزشی تحت سخت افزار های GebraBit STM32F303, GebraBit ATMEGA32A یا Arduino می باشد را دانلود کند.
تمامی توابع و Structure های تعریف شده در کتابخانه ، با جزئیات کامل، کامنت گذاری شده و تمامی پارامتر های دریافتی در آرگومان توابع و مقادیر بازگشتی از آنها ، به اختصار توضیح داده شده است.با توجه به مستقل از سخت افزار بودن کتابخانه ها،کاربر به راحتی می تواند آن را در هر یک از کامپایلر های دلخواه اضافه کرده و با میکروکنترلر و برد توسعه مورد علاقه خود، آن را توسعه دهد.
فایل هدر GebraBit_ICM20948.h
در این فایل بر اساس دیتاشیت سنسور یا ای سی ، تمامی آدرس رجیسترها، مقادیر هریک از رجیسترها به صورت Enumeration تعریف شده است.همچنین بدنه سنسور ICM20948 و کانفیگ های مربوط به هریک از بلوک های داخلی سنسور ICM20948 به صورت STRUCT با نام GebraBit_ICM20948 نیز تعریف شده است.که نهایتا در محیط Debug Session تمامی کانفیگ های مربوط به هر بلوک به صورت Real Time قابل مشاهده است.
enum ICM20948_Bank_Sel
بانک های رجیستری داخلی سنسور، در این enum تعریف شده است:
typedef enum bank_sel
{
BANK_0 = 0 ,
BANK_1 ,
BANK_2 ,
BANK_3
} ICM20948_Bank_Sel;
enum ICM20948_Interface
برای انتخاب پروتکل ارتباطی با سنسور از این enum استفاده می شود:
typedef enum interface
{
NOT_SPI = 0,
IS_SPI
}ICM20948_Interface;
enum ICM20948_Accel_Fs_Sel
برای انتخاب مقدار Full Scale سنسور Accelerometer از این enum استفاده می شود:
typedef enum accel_fs_sel
{
FULL_SCALE_2g = 0 ,
FULL_SCALE_4g ,
FULL_SCALE_8g ,
FULL_SCALE_16g
}ICM20948_Accel_Fs_Sel;
enum ICM20948_ Accel_Scale_Factor
برای انتخاب مقدار Scale Factor سنسور Accelerometer از این enum استفاده می شود:
typedef enum Accel_Scale_Factor
{
SCALE_FACTOR_16384_LSB_g = 16384,
SCALE_FACTOR_8192_LSB_g = 8192 ,
SCALE_FACTOR_4096_LSB_g = 4096 ,
SCALE_FACTOR_2048_LSB_g = 2048
}ICM20948_Accel_Scale_Factor;
enum ICM20948_Gyro_Fs_Sel
برای انتخاب مقدار Full Scale سنسور Gyroscope از این enum استفاده می شود:
typedef enum gyro_fs_sel
{
FS_250_DPS ,
FS_500_DPS ,
FS_1000_DPS,
FS_2000_DPS
}ICM20948_Gyro_Fs_Sel;
enum ICM20948_Gyro_Scale_Factor
برای انتخاب مقدار Scale Factor سنسور Gyroscope از این enum استفاده می شود
typedef enum Gyro_Scale_Factor
{
SCALE_FACTOR_131_LSB_DPS = 131 ,
SCALE_FACTOR_65p5_LSB_DPS = 65 ,
SCALE_FACTOR_32p8_LSB_DPS = 32 ,
SCALE_FACTOR_16p4_LSB_DPS = 16
}ICM20948_Gyro_Scale_Factor;
enum ICM20948_FIFO_MODE
حالت کاری FIFO سنسور با استفاده از مقادیر این enum تنظیم می شود:
typedef enum FIFO_Mode
{
STREAM_TO_FIFO ,
STOP_ON_FULL_FIFO_SNAPSHOT = 31
}ICM20948_FIFO_MODE ;
enum ICM20948_Ability
برای فعال و غیر فعال کردن بخش های مختلف سنسور از مقادیر این enum استفاده می شود:
typedef enum Ability
{
Disable = 0,
Enable
}ICM20948_Ability;
enum ICM20948_Power_Mode
برای تنظیم حالت Power Mode سنسور از مقادیر این enum استفاده می شود:
typedef enum Power_Mode
{
ICM20948_LOW_NOISE = 0,
ICM20948_LOW_POWER = 1,
ICM20948_SLEEP_OFF = 2
} ICM20948_Power_Mode;
enum ICM20948_ GYRO_Averaging_Filter
برای تعیین فیلتر مورد استفاده در سنسور Gyroscope در حالت Low Power از مقادیر این enum استفاده می شود:
typedef enum
{
GYRO_AVERAGE_1_SAMPLES_FILTER = 0 ,
GYRO_AVERAGE_2_SAMPLES_FILTER = 1 ,
GYRO_AVERAGE_4_SAMPLES_FILTER = 2 ,
GYRO_AVERAGE_8_SAMPLES_FILTER = 3 ,
GYRO_AVERAGE_16_SAMPLES_FILTER = 4 ,
GYRO_AVERAGE_32_SAMPLES_FILTER = 5 ,
GYRO_AVERAGE_64_SAMPLES_FILTER = 6 ,
GYRO_AVERAGE_128_SAMPLES_FILTER= 7
} ICM20948_GYRO_Averaging_Filter;
enum ICM20948_ ACCEL_Averaging_Filter
برای تعیین فیلتر مورد استفاده در سنسور Accelerometer در حالت Low Power از مقادیر این enum استفاده می شود:
typedef enum ACCEL_Averaging_Filter
{
ACCEL_AVERAGE_1_4_SAMPLES_FILTER = 0 ,
ACCEL_AVERAGE_8_SAMPLES_FILTER = 1 ,
ACCEL_AVERAGE_16_SAMPLES_FILTER = 2 ,
ACCEL_AVERAGE_32_SAMPLES_FILTER = 3
} ICM20948_ACCEL_Averaging_Filter;
enum ICM20948_Preparation
این enum منعکس کننده وضعیت آماده بودن یا نبودن هرگونه دیتایی در سنسور می باشد:
typedef enum Preparation
{
IS_NOT_Ready = 0,
IS_Ready
}ICM20948_Preparation;
enum ICM20948_Reset_Status
وضعیت نهاییReset نرم افزاری سنسور در این enum بیان شده است:
typedef enum Reset_Status
{
DONE = 0,
FAILED
}ICM20948_Reset_Status;
enum ICM20948_ FIFO_Ability
برای فعال یا غیر فعال سازی FIFO از این Enum استفاده می شود:
typedef enum FIFO_Ability
{
FIFO_DISABLE = 0,
FIFO_ENABLE
} ICM20948_FIFO_Ability;
enum ICM20948_ Get_DATA
نحوه دریافت داده از سنسور در این enum بیان شده است:
typedef enum Get_DATA
{
FROM_REGISTER = 0,
FROM_FIFO
} ICM20948_Get_DATA;
enum ICM20948_ Interrupt_Pin
برای انتخاب پین وقفه از این Enum استفاده می شود:
typedef enum Interrupt_Pin
{
INTERRUPT_ON_PIN_1 = 0,
INTERRUPT_ON_PIN_2
} ICM20948_Interrupt_Pin;
enum ICM20948_ DMP_LP
برای فعال یا غیر فعال سازی DMP در حالت LOW POWER از این Enum استفاده می شود:
typedef enum DMP_LP
{
NOT_DMP_LOW_POWER = 0,
DMP_LOW_POWER
} ICM20948_DMP_LP;
enum ICM20948_ Sleep
برای تنظیم حالت کاری سنسور از مقادیر این enum استفاده می شود :
typedef enum Sleep
{
ICM20948_AWAKE = 0 ,
ICM20948_SLEEP
}ICM20948_Sleep ;
enum ICM20948_Clock_Source
برای کلاک سنسور از مقادیر این enum تنظیم می شود:
typedef enum Clock_Source
{
INTERNAL_20MHZ_OSCILLATOR = 0 ,
AUTO_SELECT = 1 ,
CLOCK_STOP = 7
}ICM20948_Clock_Source ;
enum ICM20948_ Sensor
برای فعال یا غیر فعال کردن هریک از سنسور ها از مقادیر این enum استفاده می شود:
typedef enum Sensor
{
SENSOR_ENABLE = 0 ,
SENSOR_DISABLE = 7
}ICM20948_Sensor ;
enum ICM20948_ INT_Level
برای تعیین سطح لاجیک پایه Interrupt از مقادیر این enum استفاده می شود:
typedef enum int_level
{
ACTIVE_HIGH = 0 ,
ACTIVE_LOW
} ICM20948_INT_Level;
enum ICM20948_ Latch_Type
برای تعیین نوع latch شدن خروجی Interrupt از مقادیر این enum استفاده می شود:
typedef enum latch_type
{
_50_US = 0,
HELD_STATUS_CLEAR
} ICM20948_Latch_Type;
enum ICM20948_ INT_Type
برای تعیین نوع خروجی Interrupt از مقادیر این enum استفاده می شود:
typedef enum int_type
{
PUSH_PULL = 0 ,
OPEN_DRAIN
}ICM20948_INT_Type;
enum ICM20948_ FIFO_Reset
با استفاده از مقادیر این Enum میتوان FIFO سنسور را ریست کرد:
typedef enum FIFO_Reset
{
FIFO_DE_ASSERT = 0 ,
FIFO_ASSERT = 31
} ICM20948_FIFO_Reset;
enum ICM20948_ FIFO_Overflow
مقادیر این enum نشانگر Overflow شدن یا نشدن FIFO می باشد:
typedef enum FIFO_Overflow
{
NOT_OVERFLOW = 0 ,
FIFO_OVERFLOW = 1
} ICM20948_FIFO_Overflow;
enum ICM20948_ sample_rate
مقادیر این enum مقدار نرخ داده خروجی را تعیین می کند:
typedef enum sample_rate
{
_1_25_KHz = 1125 ,
_4_5_KHz = 4500 ,
_9_KHz = 9000
}ICM20948_Sample_Rate ;
enum ICM20948_ Data_Copy_FIFO
مقادیر این enum کپی شدن داده ها در FIFO را مشخص می کند:
typedef enum Data_Copy_FIFO
{
NOT_COPY_FIFO = 0 ,
COPY_TO_FIFO = 3
} ICM20948_Data_Copy_FIFO;
enum ICM20948_ FCHOICEB
برای فعال یا غیر فعال کردن فیلتر DLPF از مقادیر این enum استفاده می شود:
typedef enum FCHOICEB
{
ENABLE_DLPF_FCHOICEB = 1 ,
BYPASS_DLPF_FCHOICEB = 0 ,
}ICM20948_FCHOICEB;
enum ICM20948_ Gyro_DLPF_CFG
برای تعیین فیلتر DLPF در سنسور ژیروسکوپ از مقادیر این enum استفاده می شود:
typedef enum Gyro_DLPF_CFG
{
ICM20948_GYRO_DLPF_196 = 0,
ICM20948_GYRO_DLPF_152 = 1,
ICM20948_GYRO_DLPF_119 = 2,
ICM20948_GYRO_DLPF_51 = 3,
ICM20948_GYRO_DLPF_24 = 4,
ICM20948_GYRO_DLPF_12 = 5,
ICM20948_GYRO_DLPF_6 = 6,
ICM20948_GYRO_DLPF_361 = 7
}ICM20948_GYRO_DLPF ;
enum ICM20948_ Accel_DLPF_CFG
برای تعیین فیلتر DLPF در سنسور شتاب سنج از مقادیر این enum استفاده می شود:
typedef enum Accel_DLPF_CFG
{
ICM20948_ACCEL_DLPF_246 = 1,
ICM20948_ACCEL_DLPF_111 = 2,
ICM20948_ACCEL_DLPF_50 = 3,
ICM20948_ACCEL_DLPF_24 = 4,
ICM20948_ACCEL_DLPF_11 = 5,
ICM20948_ACCEL_DLPF_6 = 6,
ICM20948_ACCEL_DLPF_473 = 7
}ICM20948_ACCEL_DLPF ;
enum ICM20948_ Temp_DLPF_CFG
برای تعیین فیلتر DLPF در سنسور دما از مقادیر این enum استفاده می شود:
typedef enum Temp_DLPF_CFG
{
ICM20948_TEMP_DLPF_7932 = 0,
ICM20948_TEMP_DLPF_218 = 1,
ICM20948_TEMP_DLPF_123 = 2,
ICM20948_TEMP_DLPF_66 = 3,
ICM20948_TEMP_DLPF_34 = 4,
ICM20948_TEMP_DLPF_17 = 5,
ICM20948_TEMP_DLPF_9 = 6,
}ICM20948_TEMP_DLPF ;
enum ICM20948_ Aux_Between
برای کنترل RESTART و STOP در ارتباط I2Cجانبی از مقادیر این enum استفاده می شود:
typedef enum Aux_Between
{
RESTART = 0 ,
STOP
} ICM20948_Aux_Between;
enum ICM20948_ I2C_Slave
برای مشخص کردن شماره Slave در ارتباط I2Cجانبی از مقادیر این enum استفاده می شود:
typedef enum I2C_Slave
{
SLAVE_0 = 0 ,
SLAVE_1 = 1 ,
SLAVE_2 = 2 ,
SLAVE_3 = 3 ,
SLAVE_4
} ICM20948_I2C_Slave;
enum ICM20948_ AK09916_Power
برای انتخاب حالت کاری سنسور داخلی AK09916 از مقادیر این enum استفاده می شود:
typedef enum AK09916_Power
{
AK09916_POWER_DOWN = 0 ,
AK09916_SINGLE_MEASUREMENT = 1 ,
AK09916_CONTINUOUS_MEASUREMENT = 2 ,
AK09916_SELF_TEST = 65536
} AK09916_Power_Mode;
ساختار GebraBit_ICM20948
تمامی اطلاعات و کانفیگ اجرا شده بر روی سنسور در این Structure ذخیره شده و می تواند تغییرات در هر بخش از سنسور را در محیط Debug Session مشاهده نمود.
اعلان توابع
در پایان این فایل تمامی توابع جهت خواندن و نوشتن در رجیستر های ICM20948 ، کانفیک سنسور و FIFO و دریافت داده از سنسور اعلان شده است:
/********************************************************
*Declare Read&Write ICM20948 Register Values Functions *
********************************************************/
extern uint8_t GB_ICM20948_Read_Reg_Data ( uint8_t regAddr, ICM20948_Bank_Sel regBank, uint8_t* data);
extern uint8_t GB_ICM20948_Read_Reg_Bits (uint8_t regAddr, ICM20948_Bank_Sel regBank, uint8_t start_bit, uint8_t len, uint8_t* data);
extern uint8_t GB_ICM20948_Burst_Read(uint8_t regAddr, ICM20948_Bank_Sel regBank, uint8_t *data, uint16_t byteQuantity);
extern uint8_t GB_ICM20948_Write_Reg_Data(uint8_t regAddr, ICM20948_Bank_Sel regBank, uint8_t data);
extern uint8_t GB_ICM20948_Write_Reg_Bits(uint8_t regAddr, ICM20948_Bank_Sel regBank, uint8_t start_bit, uint8_t len, uint8_t data);
extern uint8_t GB_ICM20948_Burst_Write ( uint8_t regAddr, ICM20948_Bank_Sel regBank, uint8_t *data, uint16_t byteQuantity);
/********************************************************
* Declare ICM20948 Configuration Functions *
********************************************************/
extern void GB_ICM20948_Soft_Reset ( GebraBit_ICM20948 * ICM20948 );
extern void GB_ICM20948_Bank_Selection( ICM20948_Bank_Sel bsel);
extern void GB_ICM20948_Who_am_I(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_Select_SPI4_Interface(GebraBit_ICM20948 * ICM20948 , ICM20948_Interface spisel);
extern void GB_ICM20948_DMP(GebraBit_ICM20948* ICM20948 ,ICM20948_Ability dmp,ICM20948_DMP_LP dmp_lp);
extern void GB_ICM20948_DMP_Reset(GebraBit_ICM20948* ICM20948 ,ICM20948_Ability rst);
extern void GB_ICM20948_DMP_Interrupt( ICM20948_Ability interrupt);
extern void GB_ICM20948_Sleep_Awake (GebraBit_ICM20948 * ICM20948, ICM20948_Sleep working ) ;
extern void GB_ICM20948_ACCEL_Power_Mode(GebraBit_ICM20948* ICM20948 ,ICM20948_Power_Mode pmode);
extern void GB_ICM20948_GYRO_Power_Mode(GebraBit_ICM20948* ICM20948 ,ICM20948_Power_Mode pmode);
extern void GB_ICM20948_Set_Clock_Source(GebraBit_ICM20948 * ICM20948 , ICM20948_CLK clk) ;
extern void GB_ICM20948_Temperature(GebraBit_ICM20948* ICM20948 ,ICM20948_Ability temp);
extern void GB_ICM20948_Accelerometer(GebraBit_ICM20948 * ICM20948 , ICM20948_Sensor accel);
extern void GB_ICM20948_Gyroscope(GebraBit_ICM20948 * ICM20948 , ICM20948_Sensor gyro) ;
extern void GB_ICM20948_Set_INT1_Pin(GebraBit_ICM20948 * ICM20948 , ICM20948_INT_Level level ,ICM20948_INT_Type type , ICM20948_Latch_Type latch );
extern void Interrupt_Status_Enable(GebraBit_ICM20948 * ICM20948 , ICM20948_Ability interrupt );
extern ICM20948_Preparation GB_ICM20948_Check_Data_Preparation(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_GYRO_Full_Scale ( GebraBit_ICM20948 * ICM20948 , ICM20948_Gyro_Fs_Sel fs ) ;
extern void GB_ICM20948_GYRO_Low_Pass_Filter (GebraBit_ICM20948 * ICM20948 , ICM20948_FCHOICEB bypass ) ;
extern void GB_ICM20948_GYRO_Low_Pass_Filter_Value (GebraBit_ICM20948 * ICM20948 , ICM20948_GYRO_DLPF dlpf );
extern void GB_ICM20948_GYRO_LP_Averaging_Filter (GebraBit_ICM20948 * ICM20948 , ICM20948_GYRO_Averaging_Filter avg );
extern void GB_ICM20948_GYRO_Output_Sample_Rate (GebraBit_ICM20948 * ICM20948 , uint16_t rate_hz);
extern void GB_ICM20948_ACCEL_Full_Scale ( GebraBit_ICM20948 * ICM20948 , ICM20948_Accel_Fs_Sel fs );
extern void GB_ICM20948_ACCEL_Low_Pass_Filter (GebraBit_ICM20948 * ICM20948 , ICM20948_FCHOICEB bypass );
extern void GB_ICM20948_ACCEL_Low_Pass_Filter_Value (GebraBit_ICM20948 * ICM20948 , ICM20948_ACCEL_DLPF dlpf );
extern void GB_ICM20948_ACCEL_LP_Averaging_Filter (GebraBit_ICM20948 * ICM20948 , ICM20948_ACCEL_Averaging_Filter avg );
extern void GB_ICM20948_ACCEL_Output_Sample_Rate (GebraBit_ICM20948 * ICM20948 , uint16_t rate_hz);
extern void GB_ICM20948_TEMP_Low_Pass_Filter_Value (GebraBit_ICM20948 * ICM20948 , ICM20948_TEMP_DLPF tdlpf );
/********************************************************
* Declare ICM20948 FIFO Functions *
********************************************************/
extern void GB_ICM20948_Access_Serial_Interface_To_FIFO(GebraBit_ICM20948 * ICM20948 , ICM20948_Ability interface_access_fifo);
extern ICM20948_FIFO_Overflow GB_ICM20948_Check_FIFO_Overflow(GebraBit_ICM20948 * ICM20948) ;
extern void GB_ICM20948_Write_ACCEL_FIFO(GebraBit_ICM20948 * ICM20948 , ICM20948_Ability accel_fifo ) ;
extern void GB_ICM20948_Write_GYRO_FIFO(GebraBit_ICM20948 * ICM20948 , ICM20948_Ability gyro_fifo ) ;
extern void GB_ICM20948_Write_TEMP_FIFO(GebraBit_ICM20948 * ICM20948 , ICM20948_Ability temp_fifo );
extern void GB_ICM20948_Write_Slave_FIFO(GebraBit_ICM20948 * ICM20948 ,ICM20948_I2C_Slave slave , ICM20948_Ability slv_fifo );
extern void GB_ICM20948_FIFO_Mode(GebraBit_ICM20948 * ICM20948 , ICM20948_FIFO_Mode fifo_mode );
extern void GB_ICM20948_FIFO_Reset(void) ;
extern void GB_ICM20948_GET_FIFO_Count (GebraBit_ICM20948 * ICM20948 ) ;
extern void GB_ICM20948_Read_FIFO(GebraBit_ICM20948 * ICM20948 , uint16_t qty);
extern ICM20948_Data_Copy_FIFO GB_ICM20948_Check_Data_Copy_TO_FIFO(GebraBit_ICM20948 * ICM20948) ;
/********************************************************
* Declare ICM20948 DATA Functions *
********************************************************/
extern void GB_ICM20948_Get_Temp_Register_Raw_Data(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_Get_Temp_Valid_Data(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_Get_GYRO_X_Register_Raw_DATA(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_Get_GYRO_Y_Register_Raw_DATA(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_Get_GYRO_Z_Register_Raw_DATA(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_Get_GYRO_DATA_X_Valid_Data(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_Get_GYRO_DATA_Y_Valid_Data(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_Get_GYRO_DATA_Z_Valid_Data(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_Get_ACCEL_X_Register_Raw_DATA(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_Get_ACCEL_Y_Register_Raw_DATA(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_Get_ACCEL_Z_Register_Raw_DATA(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_Get_ACCEL_DATA_X_Valid_Data(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_Get_ACCEL_DATA_Y_Valid_Data(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_Get_ACCEL_DATA_Z_Valid_Data(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_Get_Temperature(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_Get_XYZ_GYROSCOPE(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_Get_XYZ_ACCELERATION(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_Get_ACCEL_GYRO_TEMP_MAG_From_Registers(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_FIFO_Data_Partition_ACCEL_GYRO_MAG_XYZ_TEMP(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_Get_ACCEL_GYRO_MAG_TEMP_From_FIFO(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_Get_Data(GebraBit_ICM20948 * ICM20948 , ICM20948_Get_DATA get_data);
extern void GB_ICM20948_Get_XYZ_AK09916_Magnetometer(GebraBit_ICM20948 * ICM20948);
/********************************************************
* Declare ICM20948 HIGH LEVEL Functions *
********************************************************/
extern void GB_ICM20948_FIFO_Configuration ( GebraBit_ICM20948 * ICM20948 , ICM20948_FIFO_Ability fifo );
extern void GB_ICM20948_Set_Power_Management(GebraBit_ICM20948 * ICM20948 , ICM20948_Power_Mode pmode) ;
extern void GB_ICM20948_initialize( GebraBit_ICM20948 * ICM20948 );
extern void GB_ICM20948_Configuration(GebraBit_ICM20948 * ICM20948, ICM20948_FIFO_Ability fifo);
/********************************************************
* Declare ICM20948 AUX I2C and AK09916 Functions *
********************************************************/
extern void GB_ICM20948_AUX_I2C_Between_Reads(GebraBit_ICM20948 * ICM20948,ICM20948_Aux_Between bet );
extern void GB_ICM20948_External_Sensor_ODR(GebraBit_ICM20948 * ICM20948,uint8_t devider);
extern void GB_ICM20948_AUX_Initialize(GebraBit_ICM20948 * ICM20948);
extern void GB_ICM20948_AUX_I2C(GebraBit_ICM20948 * ICM20948,ICM20948_Ability aux);
extern void GB_ICM20948_Stop_AUX_I2C(GebraBit_ICM20948 * ICM20948,ICM20948_I2C_Slave slave);
extern void GB_ICM20948_Set_AUX_I2C_Read(GebraBit_ICM20948 * ICM20948, ICM20948_I2C_Slave slave, uint8_t slave_addr, uint8_t slave_reg, uint8_t data_len);
extern void GB_ICM20948_AUX_I2C_Read_Data(GebraBit_ICM20948 * ICM20948, ICM20948_I2C_Slave slave, uint8_t slave_addr, uint8_t slave_reg, uint8_t data_len, uint8_t * data);
extern void GB_ICM20948_Set_AUX_I2C_Write(GebraBit_ICM20948 * ICM20948, ICM20948_I2C_Slave slave, uint8_t slave_addr, uint8_t slave_reg, uint8_t data);
extern void GB_ICM20948_AUX_I2C_Write_Data(GebraBit_ICM20948 * ICM20948, ICM20948_I2C_Slave slave, uint8_t slave_addr, uint8_t slave_reg, uint8_t data);
extern void GB_ICM20948_Get_AK09916_Device_ID(GebraBit_ICM20948 * ICM20948) ;
extern ICM20948_Preparation GB_ICM20948_Check_AK09916_Data_Preparation(GebraBit_ICM20948 * ICM20948) ;
extern void GB_ICM20948_Set_AK09916_Magnetometer_Power_Mode(GebraBit_ICM20948 * ICM20948 , AK09916_Power_Mode pmode) ;
extern void GB_ICM20948_Set_AK09916_Soft_Reset(GebraBit_ICM20948 * ICM20948) ;
extern void GB_ICM20948_Config_AK09916_Magnetometer(GebraBit_ICM20948 * ICM20948) ;
extern void GB_ICM20948_Read_AK09916_Status_2(GebraBit_ICM20948 * ICM20948) ;
فایل سورس GebraBit_ICM20948.c
در این فایل که به زبان C نوشته شده ، تمامی توابع با جزئیات کامل، کامنت گذاری شده و تمامی پارامتر های دریافتی در آرگومان توابع و مقادیر بازگشتی از آنها ، بطور واضح توضیح داده شده است.از این رو در این قسمت به همین توضیحات اکتفا کرده و کاربران را برای اطلاعات بیشتر به بررسی مستقیم از این فایل دعوت می کنیم.
برنامه نمونه در Keil
بعد از تولید پروژه Keil با استفاده از STM32CubeMX و اضافه کردن کتابخانه GebraBit_ICM20948.c ارائه شده توسط GebraBit ، به بررسی قسمت اصلی برنامه آموزشی نمونه، فایل main.c و مشاهده خروجی ماژول GebraBit ICM20948 در قسمت watch در محیط Debugging برنامه Keil می پردازیم.
شرح فایل main.c
اگر به ابتدای فایل main.c دقت کنید،متوجه می شوید که هدر GebraBit_ICM20948.h برای دسترسی به ساختار ها ، Enum ها و توابع مورد نیاز ماژول GebraBit ICM20948 ، اضافه شده است.در قسمت بعدی متغیری به نام ICM20948_Module از نوع ساختار GebraBit_ICM20948 (این ساختار در هدر GebraBit_ICM20948 بوده و در بخش توضیحات کتابخانه GebraBit_ICM20948توضیح داده شد) که برای پیکربندی ماژول GebraBit ICM20948 می باشد،تعریف شده است:
/* Private typedef -----------------------------------------------------------*/
/* USER CODE BEGIN PTD */
GebraBit_ICM20948 ICM20948_Module;
/* USER CODE END PTD */
در بخش بعدی کد نوشته شده، پیکربندی و تنظیمات ماژول GebraBit ICM20948 با استفاده از توابع GB_ICM20948_initialize() و GB_ICM20948_Configuration()، انجام شود:
GB_ICM20948_initialize( &ICM20948_Module );
GB_ICM20948_Configuration(&ICM20948_Module ,FIFO_ENABLE);
//GB_ICM20948_Configuration(&ICM20948_Module , FIFO_DISABLE );
GB_ICM20948_Config_AK09916_Magnetometer(&ICM20948_Module);
و در نهایت در قسمت while برنامه ، مقادیر ماژول GebraBit ICM20948 در 3 محور X , Y , Z و دما به طور پیوسته دریافت میشود:
GB_ICM20948_Get_Data( &ICM20948_Module , FROM_REGISTER);
//GB_ICM20948_Get_Data( &ICM20948_Module , FROM_FIFO);
با خارج کردن توابع GB_ICM20948_Configuration(&ICM20948_Module , FIFO_DISABLE ); و GB_ICM20948_Get_Data( &ICM20948_Module , FROM_REGISTER ); می توان مقادیر داده ها را مستقیم از رجیستر های داده خواند.
متن کد فایل main.c:
/* USER CODE BEGIN Header */
/*
* ________________________________________________________________________________________________________
* Copyright (c) 2020 GebraBit Inc. All rights reserved.
*
* This software, related documentation and any modifications thereto (collectively “Software”) is subject
* to GebraBit and its licensors' intellectual property rights under U.S. and international copyright
* and other intellectual property rights laws.
*
* GebraBit and its licensors retain all intellectual property and proprietary rights in and to the Software
* and any use, reproduction, disclosure or distribution of the Software without an express license agreement
* from GebraBit is strictly prohibited.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
* NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT IN
* NO EVENT SHALL GebraBit BE LIABLE FOR ANY DIRECT, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
* OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
* NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
* OF THE SOFTWARE.
* ________________________________________________________________________________________________________
*/
/**
******************************************************************************
* @file : main.c
* @brief : Main program body
* @Author : Mehrdad Zeinali
******************************************************************************
* @attention
*
* Copyright (c) 2022 STMicroelectronics.
* All rights reserved.
*
* This software is licensed under terms that can be found in the LICENSE file
* in the root directory of this software component.
* If no LICENSE file comes with this software, it is provided AS-IS.
*
******************************************************************************
*//* USER CODE END Header */
/* Includes ------------------------------------------------------------------*/
#include "main.h"
//#include "i2c.h"
#include "spi.h"
#include "gpio.h"
#include "GebraBit_ICM20948.h"
/* Private includes ----------------------------------------------------------*/
/* USER CODE BEGIN Includes */
/* USER CODE END Includes */
/* Private typedef -----------------------------------------------------------*/
/* USER CODE BEGIN PTD */
GebraBit_ICM20948 ICM20948_Module;
/* USER CODE END PTD */
/* Private define ------------------------------------------------------------*/
/* USER CODE BEGIN PD */
/* USER CODE END PD */
/* Private macro -------------------------------------------------------------*/
/* USER CODE BEGIN PM */
/* USER CODE END PM */
/* Private variables ---------------------------------------------------------*/
/* USER CODE BEGIN PV */
/* USER CODE END PV */
/* Private function prototypes -----------------------------------------------*/
void SystemClock_Config(void);
/* USER CODE BEGIN PFP */
/* USER CODE END PFP */
/* Private user code ---------------------------------------------------------*/
/* USER CODE BEGIN 0 */
/* USER CODE END 0 */
/**
* @brief The application entry point.
* @retval int
*/
int main(void)
{
/* USER CODE BEGIN 1 */
/* USER CODE END 1 */
/* MCU Configuration--------------------------------------------------------*/
/* Reset of all peripherals, Initializes the Flash interface and the Systick. */
HAL_Init();
/* USER CODE BEGIN Init */
/* USER CODE END Init */
/* Configure the system clock */
SystemClock_Config();
/* USER CODE BEGIN SysInit */
/* USER CODE END SysInit */
/* Initialize all configured peripherals */
MX_GPIO_Init();
//MX_I2C1_Init();
MX_SPI1_Init();
/* USER CODE END 2 */
/* Infinite loop */
/* USER CODE BEGIN WHILE */
GB_ICM20948_initialize( &ICM20948_Module );
//GB_ICM20948_Configuration(&ICM20948_Module ,FIFO_ENABLE );
GB_ICM20948_Configuration(&ICM20948_Module , FIFO_DISABLE );
GB_ICM20948_Config_AK09916_Magnetometer(&ICM20948_Module);
while (1)
{
/* USER CODE END WHILE */
/* USER CODE BEGIN 3 */
GB_ICM20948_Get_Data( &ICM20948_Module , FROM_REGISTER );
//GB_ICM20948_Get_Data( &ICM20948_Module , FROM_FIFO );
}
/* USER CODE END 3 */
}
/**
* @brief System Clock Configuration
* @retval None
*/
void SystemClock_Config(void)
{
RCC_OscInitTypeDef RCC_OscInitStruct = {0};
RCC_ClkInitTypeDef RCC_ClkInitStruct = {0};
RCC_PeriphCLKInitTypeDef PeriphClkInit = {0};
/** Initializes the RCC Oscillators according to the specified parameters
* in the RCC_OscInitTypeDef structure.
*/
RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_HSE;
RCC_OscInitStruct.HSEState = RCC_HSE_ON;
RCC_OscInitStruct.HSEPredivValue = RCC_HSE_PREDIV_DIV1;
RCC_OscInitStruct.HSIState = RCC_HSI_ON;
RCC_OscInitStruct.PLL.PLLState = RCC_PLL_ON;
RCC_OscInitStruct.PLL.PLLSource = RCC_PLLSOURCE_HSE;
RCC_OscInitStruct.PLL.PLLMUL = RCC_PLL_MUL7;
if (HAL_RCC_OscConfig(&RCC_OscInitStruct) != HAL_OK)
{
Error_Handler();
}
/** Initializes the CPU, AHB and APB buses clocks
*/
RCC_ClkInitStruct.ClockType = RCC_CLOCKTYPE_HCLK|RCC_CLOCKTYPE_SYSCLK
|RCC_CLOCKTYPE_PCLK1|RCC_CLOCKTYPE_PCLK2;
RCC_ClkInitStruct.SYSCLKSource = RCC_SYSCLKSOURCE_PLLCLK;
RCC_ClkInitStruct.AHBCLKDivider = RCC_SYSCLK_DIV1;
RCC_ClkInitStruct.APB1CLKDivider = RCC_HCLK_DIV2;
RCC_ClkInitStruct.APB2CLKDivider = RCC_HCLK_DIV1;
if (HAL_RCC_ClockConfig(&RCC_ClkInitStruct, FLASH_LATENCY_2) != HAL_OK)
{
Error_Handler();
}
PeriphClkInit.PeriphClockSelection = RCC_PERIPHCLK_I2C1;
PeriphClkInit.I2c1ClockSelection = RCC_I2C1CLKSOURCE_SYSCLK;
if (HAL_RCCEx_PeriphCLKConfig(&PeriphClkInit) != HAL_OK)
{
Error_Handler();
}
}
/* USER CODE BEGIN 4 */
/* USER CODE END 4 */
/**
* @brief This function is executed in case of error occurrence.
* @retval None
*/
void Error_Handler(void)
{
/* USER CODE BEGIN Error_Handler_Debug */
/* User can add his own implementation to report the HAL error return state */
__disable_irq();
while (1)
{
}
/* USER CODE END Error_Handler_Debug */
}
#ifdef USE_FULL_ASSERT
/**
* @brief Reports the name of the source file and the source line number
* where the assert_param error has occurred.
* @param file: pointer to the source file name
* @param line: assert_param error line source number
* @retval None
*/
void assert_failed(uint8_t *file, uint32_t line)
{
/* USER CODE BEGIN 6 */
/* User can add his own implementation to report the file name and line number,
ex: printf("Wrong parameters value: file %s on line %d\r\n", file, line) */
/* USER CODE END 6 */
}
#endif /* USE_FULL_ASSERT */
خروجی برنامه
بعد از تولید پروژه Keil با استفاده از STM32CubeMX و اضافه کردن کتابخانه ، پروگرامر STLINK V2 را با استفاده از آداپتور تبدیل STLINKV2 به GebraBit STM32F303 متصل می کنیم:
آداپتور تبدیل :STLINKV2
با اتصال پروگرامر STLINK V2 به GebraBit STM32F303 دیگر نیازی به اعمال تغذیه به ماژول های GebraBit STM32F303 و GebraBit ICM20948 نمی باشد، زیرا ولتاژ کاری خود را مستقیما از پروگرامر STLINK V2 دریافت میکنند.
در نهایت وارد حالت Debug شده و با اضافه کردن ICM20948_Module به پنجره watch و اجرای برنامه ، تغییرات مقادیر دما و ماژول GebraBit ICM20948 را در 3 محور X , Y , Z هم به صورت مستقیم از رجیستر های داده و هم FIFO مشاهده می کنیم.
دریافت داده های سنسور مستقیم از رجیستر های داده :
دریافت داده های سنسور از FIFO :
در ادامه می توانید پروژه راه اندازی ماژول GebraBit ICM20948 را با استفاده از ماژول GebraBit STM32F303 در محیط Keil و فایل STM32CubeMX ، شماتیک ماژول ها و دیتاشیت ICM20948 را دانلود کنید.