client_code_fg004
/
High
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity
The Socket Protection code for the High power mode.
43 Commits 1 Branch 3 Tags 629 KiB
C 74.2%
Makefile 13%
C++ 7%
CMake 3%
Shell 2.8%
Go to file
jakeg00dwin 1761ea38d9 Extracted duplicated code for ADC. Added new helper functions. 2024-09-24 09:31:04 -07:00
.template_files Added template hidden files 2024-07-27 12:31:41 -07:00
inc Inital commit of cloned code 2024-07-27 11:59:09 -07:00
mocks Refactored to match ADC interface 2024-07-28 17:02:47 -07:00
nbproject Updated configuration in MPLABX 2024-09-14 13:10:35 -07:00
src Extracted duplicated code for ADC. Added new helper functions. 2024-09-24 09:31:04 -07:00
tests Changed the module `TriacOut` --> `EnOut` 2024-09-14 13:05:27 -07:00
.gitignore Setup git to track Makefile generated by MPLAbX 2024-07-28 17:22:05 -07:00
CMakeLists.txt Inital commit of cloned code 2024-07-27 11:59:09 -07:00
Doxyfile Inital commit of cloned code 2024-07-27 11:59:09 -07:00
Makefile Setup git to track Makefile generated by MPLAbX 2024-07-28 17:22:05 -07:00
README.md Updated to remove references to triac usage 2024-09-14 12:54:58 -07:00
avr-gcc-toolchain.cmake Inital commit of cloned code 2024-07-27 11:59:09 -07:00
defmplabxtrace.log Inital commit of cloned code 2024-07-27 11:59:09 -07:00
defmplabxtrace.log.inx Inital commit of cloned code 2024-07-27 11:59:09 -07:00
otto.sh Edited the testing automation script to make and run the correct tests. 2024-09-14 13:06:36 -07:00
setup.sh Inital commit of cloned code 2024-07-27 11:59:09 -07:00

README.md

FG004_A(High Power)

Description

This embedded firmware is the High Power mode for the software.

Micro Controller Pins

ATtiny404

  1. VDD(+5v)
  2. PA4(ADC_LOAD1)
  3. PA5(ADC_LOAD2)
  4. PA6(ADC_LOAD3)
  5. PA7(zerocrossing)
  6. PB3(EN2)
  7. PB2(EN3)
  8. PB1(SDA)
  9. PB0(SCL)
  10. RST(NC)
  11. PA1(G1)
  12. PA2(EN1)
  13. PA3(NC)
  14. VSS(GND)

key NC:: Not Connected PBX:: Port B pin X PAX:: Port A pin X RST:: Reset pin

Project Layout

Tree -L 1, output

.
├── avr-gcc-toolchain.cmake
├── build
├── CMakeLists.txt
├── compile_commands.json -> ./build/compile_commands.json
├── docs
├── Doxyfile
├── inc
├── mocks
├── otto.sh
├── README.md
├── setup.sh
├── src
└── tests

6 directories, 7 files

The source code required to run/build the project is in the /src directory, with the headers residing inside the /inc directory for most public modules.

All other directories are for supporting the development cycle and are used for testitng the code base to ensure accuracy and quality. These are contained in the tests and mocks directories.

Documentation that has been generated is inside the docs folder which contains the html output that can be browswed via your regular web browser.

PDF genreation from the doumentaiton is also possible if enabled through the Doxyfile inside the projects root directory.

The build directory contains the output and makefiles genrerated automatically when using CMake.

This build directory also holds the bin files genreated along with the hex and elf files.

Build Requirements

  • AVR-GCC toolchain OR XC8 from microchip.
  • Make OR CMAKE
  • avrdude
  • A AVR programmer, usbasp for older chips and UPDI for newer ones.

Dev Requirements

  • ATtiny404 series micro-controller
  • AVR-GCC toolchain.
  • Cmake
  • cpputest(Unit testing harness.)
  • Doxygen(For documentation)
  • Git(For version control)

Running Unit Tests

To run the cppunit tests you can use the included shell script inside a bash shell.

echo "1" | ./otto.sh

The command runs the otto script which automates parts of the development cycle such as running and building tests, compiling hex files and flashing the code to a micro-controller using arvdude.

Roadmap

Some stuff that still needs done.

  • Add ADC Mocked interface.
  • Write tests for ADC Mock
  • Write ZCD using ADC Mock.
  • Write ADC version for ATtiny404