README.md

@@ -1,68 +1,30 @@
-# CMOCKA/CMAKE template
+# gy-521 Driver
 
-## Purporse
+The gy-521 module is usally interfaced with via TWI/I2C. The actual chip that
+is used in the module is the mpu6050 ic.
 
-- Streamline the setup of new C projects
+This driver doesn't make any assumptions about the platform it will run
-- Make it easy to setup a develoment enviroment
+on beyond that it supports "stdlib.h" and "inttypes.h".
-- Allow TDD for embedded systems
-- Provide easy LSP usage via compile_commands.json
-- correctly use the CTEST command.
-- Avoid having to setup ruby/ceedling with it's dependency hell
 
-## Organization
+The interface handles all the register and bitshift operations in the 
+the backgorund. The module uses getters and setters to abstract the
+actual data. This prevents the end user from trying to directly use the 
+structures data when it is volatile and may be setup to update in a ISR.
 
-```
+## PINs
-.
-├── CMakeLists.txt
-├── LICENSE
-├── README.md
-├── build
-├── cmake
-│   └── cmocka
-│       ├── AddCCompilerFlag.cmake
-│       ├── AddCMockaTest.cmake
-│       ├── COPYING-CMAKE-SCRIPTS
-│       ├── CheckCCompilerFlagSSP.cmake
-│       ├── DefineCMakeDefaults.cmake
-│       ├── DefineCompilerFlags.cmake
-│       ├── DefinePlatformDefaults.cmake
-│       ├── FindNSIS.cmake
-│       └── MacroEnsureOutOfSourceBuild.cmake
-├── compile_commands.json -> ./build/compile_commands.json
-├── git_modules
-├── src
-│   ├── CMakeLists.txt
-│   ├── led_driver
-│   │   ├── CMakeLists.txt
-│   │   ├── led_driver.c
-│   │   └── led_driver.h
-│   ├── main.c
-│   └── main.h
-└── tests
-    ├── CMakeLists.txt
-    ├── led_driver
-    │   ├── CMakeLists.txt
-    │   └── test_led_driver.c
-    └── simple_test
-        ├── CMakeLists.txt
-        └── simple_test.c
 
-10 directories, 24 files
+- VCC: 3.3v
-```
+- GND: ground or 0v
-
+- SCL: TWI clock
-The actual code is all stored inside the src direcotry with any libs/submodules
+- SDA: TWI data
-stored inside their own subdirectories.
+- XDA:
-
+- XCL:
-The code we use to test stuff gets stored inside the dir "tests" in the 
+- AD0: changes the TWI address when pulled high.
-projects root.
+- INT: interrupt pin
-
-The compile_commands.json file in the project root is actaully a symlink to
-the generated compile_commands.json file inside the build directory. So if
-you notice your LSP isn't working correctly it probably means that you haven't
-ran cmake yet.
 
 
 ## Running and building the project
+The project uses CMake along with cmocka for unit testing.
 
 ```sh
 # change into the build dir
@@ -76,33 +38,12 @@ ctest
 
 ```
 
-# Adding tests
-
-To actually add tests to the project create a new directory inside the
-"tests" dir. From there it will need a source.c and CMAKELists.txt file.
-
-You will also need to include it inside the tests/CMakeLists.txt file as well.
-
-```cmake
-add_subdirectory(new_test)
-```
-
 ## RoadMap
 
-Things I want to add in the future:
+- add in functions for interrupt driven updates.
-
+- add functions for configuration of module.
-- Automatic module creation
+- add functions to save configurations in memory.
-- template generation
+- add functions to load saved configs
-- header --> mocking
-- report generation
-- embedded specific scripts for common hardware items
-
-
-
-
-##TDD stuff
-
-- what does a struct typedef <name_struct> \*struct actually mean?