Merge pull request #235 from RobertGawron/feature/unify_folder_structure
Feature/unify folder structurepull/236/head
|
@ -6,7 +6,7 @@ matrix:
|
|||
sudo: true
|
||||
before_install:
|
||||
- sudo apt-get install -y sdcc cmake
|
||||
- cd ./software/Firmware
|
||||
- cd ./Software/Firmware
|
||||
script:
|
||||
- sdcc --version
|
||||
- mkdir build_directory
|
||||
|
@ -20,7 +20,7 @@ matrix:
|
|||
sudo: true
|
||||
before_install:
|
||||
- sudo apt-get install -y texlive-latex-base texlive-latex-extra texlive-extra-utils poppler-utils
|
||||
- cd ./documentation/diagrams
|
||||
- cd ./Documentation/Diagrams
|
||||
script:
|
||||
- chmod +x ./creatediagrams.sh
|
||||
- ./creatediagrams.sh
|
||||
|
@ -31,7 +31,7 @@ matrix:
|
|||
sudo: true
|
||||
before_install:
|
||||
- sudo apt-get install -y cppcheck
|
||||
- cd ./software/Firmware
|
||||
- cd ./Software/Firmware
|
||||
script:
|
||||
- cppcheck --enable=all --inline-suppr --force --quiet --error-exitcode=1 Src/* Inc/*
|
||||
|
||||
|
@ -42,7 +42,7 @@ matrix:
|
|||
before_install:
|
||||
- sudo apt-get install -y python3-pip
|
||||
- pip3 install pyflakes
|
||||
- cd ./software/DataAcquisition
|
||||
- cd ./Software/DataAcquisition
|
||||
script:
|
||||
- pyflakes *.py
|
||||
|
||||
|
|
Przed Szerokość: | Wysokość: | Rozmiar: 541 KiB Po Szerokość: | Wysokość: | Rozmiar: 541 KiB |
Przed Szerokość: | Wysokość: | Rozmiar: 77 KiB Po Szerokość: | Wysokość: | Rozmiar: 77 KiB |
Przed Szerokość: | Wysokość: | Rozmiar: 88 KiB Po Szerokość: | Wysokość: | Rozmiar: 88 KiB |
Przed Szerokość: | Wysokość: | Rozmiar: 304 KiB Po Szerokość: | Wysokość: | Rozmiar: 304 KiB |
Przed Szerokość: | Wysokość: | Rozmiar: 167 KiB Po Szerokość: | Wysokość: | Rozmiar: 167 KiB |
Przed Szerokość: | Wysokość: | Rozmiar: 224 KiB Po Szerokość: | Wysokość: | Rozmiar: 224 KiB |
Przed Szerokość: | Wysokość: | Rozmiar: 225 KiB Po Szerokość: | Wysokość: | Rozmiar: 225 KiB |
Przed Szerokość: | Wysokość: | Rozmiar: 747 KiB Po Szerokość: | Wysokość: | Rozmiar: 747 KiB |
|
@ -10,14 +10,14 @@ When air's atoms are hit by radioactive particles, an ion-pair is produced. Ions
|
|||
|
||||
They will try to "meet each other" (I don't know how to explain it) thus creating a current. This current can be measured. The current is proportional to amount of ion-pairs. Amount of ion-pairs is proportional to radioactivity level.
|
||||
|
||||
![architecture](https://raw.githubusercontent.com/RobertGawron/IonizationChamber/master/documentation/pictures/pcb_01_09_2019.jpg)
|
||||
![architecture](https://raw.githubusercontent.com/RobertGawron/IonizationChamber/master/Documentation/Pictures/pcb_01_09_2019.jpg)
|
||||
|
||||
|
||||
## System architecture
|
||||
|
||||
It is designed in a way that the device can work remotely, e.g. no connection via USB cable to user’s PC is needed.
|
||||
|
||||
![architecture](https://raw.githubusercontent.com/RobertGawron/IonizationChamber/master/documentation/diagrams/ArchitectureOverview-1.png)
|
||||
![architecture](https://raw.githubusercontent.com/RobertGawron/IonizationChamber/master/Documentation/Diagrams/ArchitectureOverview-1.png)
|
||||
|
||||
Remarks:
|
||||
* Amplifier has three stages (first stage is transimpedance amplifier, not FET like most projects use).
|
||||
|
|
|
@ -0,0 +1,7 @@
|
|||
# Firmware
|
||||
|
||||
* ["Data processing and firmware flashing" node architecture
|
||||
](https://github.com/RobertGawron/IonizationChamber/wiki/%22Data-processing-and-firmware-flashing%22-node-architecture
|
||||
)
|
||||
* [Setting up development environment on Linux
|
||||
](https://github.com/RobertGawron/IonizationChamber/wiki/Setting-up-development-environment-on-Linux)
|
|
@ -0,0 +1 @@
|
|||
build/
|
|
@ -1,10 +1,3 @@
|
|||
/*
|
||||
* ApplicationBuilder.h
|
||||
*
|
||||
* Created on: 15 cze 2019
|
||||
* Author: robert
|
||||
*/
|
||||
|
||||
#ifndef INC_APPLICATIONBUILDER_H_
|
||||
#define INC_APPLICATIONBUILDER_H_
|
||||
|
||||
|
@ -14,4 +7,4 @@ void ApplicationBuilder_Run();
|
|||
|
||||
void ApplicationBuilder_Tick();
|
||||
|
||||
#endif /* INC_APPLICATIONBUILDER_H_ */
|
||||
#endif
|
|
@ -1,7 +1,6 @@
|
|||
#ifndef SRC_BITHANDLER_H_
|
||||
#define SRC_BITHANDLER_H_
|
||||
|
||||
// TODO a bit of type checking?
|
||||
#define GET_MSB(data) (data >> 8)
|
||||
#define GET_LSB(data) (data & 0xff)
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
#ifndef INC_CLOCKCONFIGURATOR_H_
|
||||
#define INC_CLOCKCONFIGURATOR_H_
|
||||
|
||||
void ClockConfigurator_Init();
|
||||
|
||||
|
||||
#endif
|
|
@ -1,10 +1,3 @@
|
|||
/*
|
||||
* CommonDataTypes.h
|
||||
*
|
||||
* Created on: 15 cze 2019
|
||||
* Author: robert
|
||||
*/
|
||||
|
||||
#ifndef INC_COMMONDATATYPES_H_
|
||||
#define INC_COMMONDATATYPES_H_
|
||||
|
||||
|
@ -14,4 +7,4 @@
|
|||
|
||||
#include "stm8s.h"
|
||||
|
||||
#endif /* INC_COMMONDATATYPES_H_ */
|
||||
#endif
|
|
@ -1,10 +1,3 @@
|
|||
/*
|
||||
* DataLogger.h
|
||||
*
|
||||
* Created on: 16.06.2019
|
||||
* Author: robert
|
||||
*/
|
||||
|
||||
#ifndef INC_LOGGER_H_
|
||||
#define INC_LOGGER_H_
|
||||
|
||||
|
@ -16,4 +9,4 @@ void Logger_Init();
|
|||
|
||||
void Logger_Print(Logger_DataFormat_t data);
|
||||
|
||||
#endif /* INC_LOGGER_H_ */
|
||||
#endif
|
|
@ -1,10 +1,3 @@
|
|||
/*
|
||||
* MeasurementCollector.h
|
||||
*
|
||||
* Created on: 15 cze 2019
|
||||
* Author: robert
|
||||
*/
|
||||
|
||||
#ifndef INC_MEASUREMENTCOLLECTOR_H_
|
||||
#define INC_MEASUREMENTCOLLECTOR_H_
|
||||
|
||||
|
@ -12,4 +5,4 @@ void MeasurementCollector_Init();
|
|||
|
||||
void MeasurementCollector_Tick();
|
||||
|
||||
#endif /* INC_MEASUREMENTCOLLECTOR_H_ */
|
||||
#endif
|
|
@ -1,10 +1,3 @@
|
|||
/*
|
||||
* MeasurementFrame.h
|
||||
*
|
||||
* Created on: 06.07.2019
|
||||
* Author: robert
|
||||
*/
|
||||
|
||||
#ifndef INC_MEASUREMENTFRAME_H_
|
||||
#define INC_MEASUREMENTFRAME_H_
|
||||
|
||||
|
@ -15,4 +8,4 @@ void MeasurementFrame_Create(uint8_t configuration, uint16_t data);
|
|||
/* Dependency injection. This module require a function that take character as an argument and print it somewhere. */
|
||||
bool MeasurementFrame_Send(void (*sendFunction)(uint8_t));
|
||||
|
||||
#endif /* INC_MEASUREMENTFRAME_H_ */
|
||||
#endif
|
|
@ -1,9 +1,3 @@
|
|||
/*
|
||||
* PinoutConfiguration.h
|
||||
*
|
||||
* Created on: 15 cze 2019
|
||||
* Author: robert
|
||||
*/
|
||||
#include "CommonDataTypes.h"
|
||||
|
||||
#ifndef INC_PINOUTCONFIGURATION_H_
|
||||
|
@ -26,4 +20,4 @@
|
|||
#define PIN_I2C_SCL GPIO_PIN_4
|
||||
#define PIN_I2C_SDA GPIO_PIN_5
|
||||
|
||||
#endif /* INC_PINOUTCONFIGURATION_H_ */
|
||||
#endif
|
|
@ -0,0 +1,6 @@
|
|||
#ifndef INC_TIMERCONFIGURATOR_H_
|
||||
#define INC_TIMERCONFIGURATOR_H_
|
||||
|
||||
void TimerConfigurator_Init();
|
||||
|
||||
#endif
|
|
@ -1,10 +1,3 @@
|
|||
/*
|
||||
* UserInterface.h
|
||||
*
|
||||
* Created on: 30.06.2019
|
||||
* Author: robert
|
||||
*/
|
||||
|
||||
#ifndef SRC_GUI_H_
|
||||
#define SRC_USER_INTERFACE_H_
|
||||
|
||||
|
@ -16,4 +9,4 @@ void UserInterface_Tick();
|
|||
|
||||
void UserInterface_ShowMessage(UserInterface_Status status);
|
||||
|
||||
#endif /* SRC_GUI_H_ */
|
||||
#endif
|
|
@ -1,10 +1,3 @@
|
|||
/*
|
||||
* VoltageSensorActualValue.h
|
||||
*
|
||||
* Created on: 04.06.2019
|
||||
* Author: robert
|
||||
*/
|
||||
|
||||
#ifndef SRC_VOLTAGESENSORACTUALVALUE_H_
|
||||
#define SRC_VOLTAGESENSORACTUALVALUE_H_
|
||||
|
||||
|
@ -18,4 +11,4 @@ bool VoltageSensorActualValue_MeasureValue(VoltageSensorActualValue_MeasurementD
|
|||
|
||||
uint8_t VoltageSensorActualValue_GetConfiguration();
|
||||
|
||||
#endif /* SRC_VOLTAGESENSORACTUALVALUE_H_ */
|
||||
#endif
|
|
@ -0,0 +1,9 @@
|
|||
# Firmware
|
||||
|
||||
* ["Data processing and firmware flashing" node architecture
|
||||
](https://github.com/RobertGawron/IonizationChamber/wiki/%22Data-processing-and-firmware-flashing%22-node-architecture
|
||||
)
|
||||
* [Setting up development environment on Linux
|
||||
](https://github.com/RobertGawron/IonizationChamber/wiki/Setting-up-development-environment-on-Linux)
|
||||
* [Firmware compilation and hardware flashing
|
||||
](https://github.com/RobertGawron/IonizationChamber/wiki/Firmware-compilation-and-hardware-flashing)
|