mpu6050 icon indicating copy to clipboard operation
mpu6050 copied to clipboard

example文件夹命名是否合适?

Open yunline opened this issue 8 months ago • 1 comments

Please ask your question

按照本仓库所给出的例程,在使用本库时需要#include "driver_mpu6050_basic.h",这个头文件在example文件夹中。. 请问example文件夹里的文件是否是只是“样例”,还是库的一部分? 如果是库的一部分,我认为命名为example是一种很怪的行为,可以给出解释吗?

Additional context

No response

yunline avatar Oct 07 '23 03:10 yunline

Thank you very much for using LibDriver and providing us with valuable feedback.

./example is not part of the LibDriver MPU6050 library. /src contains all the contents of the library. ./test, ./example, and ./interface are subsidiary parts of the library. ./test is the unit testing part of the library (also providing reference for developers to test chip functionality). ./example is the sample reference of the library. Developers can develop their own programs based on these samples. ./interface is a sample reference for cross platform porting, and developers can adapt to different chips and platforms based on the samples.

The sample program only provides a few interfaces and does not include complete calls. This part is easily misunderstood when placed in the development documentation. This is an issue with the sample program and documentation, and we will fix this issue in the future.

Thank you for your valuable suggestion.

非常感谢您使用LibDriver并给我们提出珍贵的意见。

./example并非LibDriver MPU6050库的一部分。./src包含库的全部内容,./test,./example和./interface是库的附属部分,./test是本库的单元测试部分(同时提供给开发者芯片功能测试的参考),./example是本库的样例参考,开发者可以根据这些样例开发适合自己的程序,./interface是跨平台移植的样例参考,开发者可以根据样例适配不同的芯片、平台。

样例程序只是提供了几个接口并没有包含完整的调用,这一部分放到了开发文档中容易引起误解,此为样例程序和文档的问题,我们将在后续修复此问题。

感谢您提出的宝贵建议。

libdriver avatar Oct 07 '23 14:10 libdriver