nmrr 2 лет назад
Родитель
Сommit
ba05bf594b
1 измененных файлов с 46 добавлено и 47 удалено
  1. 46 47
      README.md

+ 46 - 47
README.md

@@ -1,42 +1,44 @@
 # flipperzero-geigercounter
 # flipperzero-geigercounter
-A geiger counter application for the Flipper Zero
+☢☢ A geiger counter application for the Flipper Zero ☢☢
 
 
 ![banner](https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/logo.jpg)
 ![banner](https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/logo.jpg)
+(banner has been made with **Midjourney**)
 
 
-You need a **geiger counter** board to run this application. This board can be used : https://aliexpress.com/item/1005004074447209.html
+
+You need a **geiger counter** board to run this application, this board can be used: https://aliexpress.com/item/1005004074447209.html
 
 
 You also need jumper wires to connect the board on the **Flipper Zero**.
 You also need jumper wires to connect the board on the **Flipper Zero**.
 
 
-**Note 1 :** this board uses a **J305** geiger tube. According this [website](https://www.rhelectronics.store/j305-glassy-geiger-muller-tube-nuclear-radiation-sensor) gamma conversion factor is **0.0081** for this tube. This value has been declared in the header of the source file so you can change it easily if needed. Incorrect conversion factor will give false measurements when **Sv** or **Rad** is selected.
+**Note 1:** This board uses a **J305** geiger tube. According this [website](https://www.rhelectronics.store/j305-glassy-geiger-muller-tube-nuclear-radiation-sensor) gamma conversion factor is **0.0081** for this tube. This value has been declared in the header of the source file so you can change it easily if needed. Incorrect conversion factor will give false measurements when **Sv** or **Rad** is selected.
 
 
-**Note 2 :** **J305** geiger tube is only sensible to **beta** and **gamma** rays. **Alpha** rays cannot be detected. 
+**Note 2:** **J305** geiger tube is only sensible to **beta** and **gamma** rays. **Alpha** rays cannot be detected. 
 
 
-**Usable** radioactive sources : 
+**Usable** radioactive sources: 
 - natural uranium (alpha, beta, gamma)
 - natural uranium (alpha, beta, gamma)
 - natural thorium (alpha, beta, gamma)
 - natural thorium (alpha, beta, gamma)
 - radium-226 (alpha, beta, gamma)
 - radium-226 (alpha, beta, gamma)
 - cobalt-60 (beta & gamma)
 - cobalt-60 (beta & gamma)
 - iodine-131 (beta & gamma)
 - iodine-131 (beta & gamma)
 
 
-**Not really usable** radioactive sources : 
-- americium-241 (alpha & low gamma, some strong beta/gamma rays are emitted during radioactive cascade or due to the present of radioisotope impurity)
+**Not really usable** radioactive sources: 
+- americium-241 (alpha & low gamma, some strong beta/gamma rays are emitted during radioactive cascade or due to the presence of radioisotope impurity)
 - high purity metallic uranium/thorium (same as am241)
 - high purity metallic uranium/thorium (same as am241)
 
 
 
 
-**Totaly unusable** radioactive sources : 
+**Totaly unusable** radioactive sources: 
 - polonium-210 (pure alpha)
 - polonium-210 (pure alpha)
 - tritium (very low beta)
 - tritium (very low beta)
 
 
 
 
 The geiger counter board can be powered with +5V power pin of the **Flipper Zero**. This pin will automatically be enabled when the program is launched. 
 The geiger counter board can be powered with +5V power pin of the **Flipper Zero**. This pin will automatically be enabled when the program is launched. 
 
 
-Output pin for measure on arduino cannot be used on the **Flipper Zero** because output voltage is too low. You can use jack out port instead. Just cut audio jack cable and connect audio channel (left, right or both together) with a cut half male jumper wire to **A7** GPIO :
+Output pin for measure on arduino cannot be used on the **Flipper Zero** because output voltage is too low. You can use jack out port instead. Just cut audio jack cable and connect audio channel (left, right or both together) with a cut half male jumper wire to **A7** GPIO:
 
 
 <p align="center"><img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/jack.png" width=40% height=40%></p>
 <p align="center"><img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/jack.png" width=40% height=40%></p>
 
 
 Black wire is usually used for the ground (sleeve on the schematic). You can use a multimeter to be sure or simply test other wires.
 Black wire is usually used for the ground (sleeve on the schematic). You can use a multimeter to be sure or simply test other wires.
 
 
-Global schema :
+Global schema:
 
 
 <p align="center"><img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/schema.jpg" width=75% height=75%></p>
 <p align="center"><img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/schema.jpg" width=75% height=75%></p>
 
 
@@ -44,7 +46,7 @@ Global schema :
 
 
 Assuming the toolchain is already installed, copy **flipper_geiger** directory to **applications_user**
 Assuming the toolchain is already installed, copy **flipper_geiger** directory to **applications_user**
 
 
-Plug your **Flipper Zero** and build the geiger counter :
+Plug your **Flipper Zero** and build the geiger counter:
 ```
 ```
 ./fbt launch_app APPSRC=applications_user/flipper_geiger
 ./fbt launch_app APPSRC=applications_user/flipper_geiger
 ```
 ```
@@ -55,18 +57,15 @@ The program will automatically be launched after compilation
 
 
 **A4** GPIO can be connected on **A7** GPIO to test this application without using a geiger tube. **A4** GPIO is generating a signal whose frequency changes every second.
 **A4** GPIO can be connected on **A7** GPIO to test this application without using a geiger tube. **A4** GPIO is generating a signal whose frequency changes every second.
 
 
-**Button assignments** : 
-
-**Ok** *[long press]* : clear the graph
-
-**Left/Right** *[short press]* : choose right unit (cpm, μSv/h, mSv/y, Rad/h, mRad/h, uRad/h), **cps** on the left is always displayed
-
-**Up** *[long press]* : enable/disable recording, led of **Flipper Zero** is colored in red when recording
-
-**Up/Down** *[short press]* : zoom/unzoom 
-
-**Back** *[long press]* : exit
+**Button assignments**: 
 
 
+button  | function
+------------- | -------------
+**Ok** *[long press]*  | Clear the graph
+**Left/Right** *[short press]* | Choose right unit (cpm, μSv/h, mSv/y, Rad/h, mRad/h, uRad/h), **cps** on the left is always displayed
+**Up** *[long press]*  | Enable/disable recording, led of **Flipper Zero** is colored in red when recording
+**Up/Down** *[short press]*  | Zoom/unzoom 
+**Back** *[long press]*  | Exit
 
 
 If you don't want to build this application, just simply copy **flipper_geiger.fap** on your **Flipper Zero** 
 If you don't want to build this application, just simply copy **flipper_geiger.fap** on your **Flipper Zero** 
 
 
@@ -74,76 +73,76 @@ Build has been made with official toolchain, **API Mismatch** error may appear i
 
 
 ## Use cases
 ## Use cases
 
 
-Ambient radioactivity (descendants of radon gas are detected, not radon itself) :
+Ambient radioactivity (descendants of radon gas are detected, not radon itself):
 
 
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper2.png" width=25% height=25%> <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper8.png" width=25% height=25%> <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper9.png" width=25% height=25%>
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper2.png" width=25% height=25%> <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper8.png" width=25% height=25%> <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper9.png" width=25% height=25%>
 
 
-Measure of uranium ore piece inside a lead container :
+Measure of uranium ore piece inside a lead container:
 
 
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper3.png" width=25% height=25%> <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper12.png" width=25% height=25%> <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper13.png" width=25% height=25%> <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper14.png" width=25% height=25%>
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper3.png" width=25% height=25%> <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper12.png" width=25% height=25%> <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper13.png" width=25% height=25%> <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper14.png" width=25% height=25%>
 
 
-**Note :** measures in **Sv** or **Rad** are not precise
+**Note:** measures in **Sv** or **Rad** are not precise
 
 
-Measure of uranium ore piece (the most radioactive part) in contact with the geiger tube :
+Measure of uranium ore piece (the most radioactive part) in contact with the geiger tube:
 
 
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper4.png" width=25% height=25%>
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper4.png" width=25% height=25%>
 
 
-Measure of radium dial pointers in contact with the geiger tube :
+Measure of radium dial pointers in contact with the geiger tube:
 
 
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper5.png" width=25% height=25%>
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper5.png" width=25% height=25%>
 
 
-All previous measures in a row (the scale of the graph is automatically adjusted) :
+All previous measures in a row (the scale of the graph is automatically adjusted):
 
 
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper6.png" width=25% height=25%>
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper6.png" width=25% height=25%>
 
 
-Measure of uranium orange pottery :
+Measure of uranium orange pottery:
 
 
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper10.png" width=25% height=25%>
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper10.png" width=25% height=25%>
 
 
-Measure of americium-241 button from a smoke detector :
+Measure of americium-241 button from a smoke detector (descendants of americium or radioisotope impurity are detected, not americium itself):
 
 
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper11.png" width=25% height=25%>
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper11.png" width=25% height=25%>
 
 
-**A4** GPIO on **A7** GPIO :
+**A4** GPIO on **A7** GPIO (to test this program without a geiger tube):
 
 
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper7.png" width=25% height=25%>
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/flipper7.png" width=25% height=25%>
 
 
-Zoom levels (the third picture is the default zoom) :
+Zoom levels (the third picture is the default zoom):
 
 
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/zoom0.png" width=25% height=25%> <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/zoom1.png" width=25% height=25%> <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/zoom2.png" width=25% height=25%> <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/zoom3.png" width=25% height=25%>
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/zoom0.png" width=25% height=25%> <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/zoom1.png" width=25% height=25%> <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/zoom2.png" width=25% height=25%> <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/zoom3.png" width=25% height=25%>
 
 
 ## Recording function
 ## Recording function
 
 
-Output **CSV** files are stored at the root of SD card. Date & time are set in the name file (example : **geiger-2023-07-03--23-48-15.csv**)
+Output **CSV** files are stored at the root of SD card. Date & time are set in the name file (example: **geiger-2023-07-03--23-48-15.csv**)
 
 
-Data sample :
+Data sample:
 
 
 epoch  | cps
 epoch  | cps
 ------------- | -------------
 ------------- | -------------
-0  | 3587
-1  | 3604
-2  | 3583
-3  | 3547
-4  | 3598
+0  | 10
+1  | 14
+2  | 8
+3  | 11
+4  | 9
 
 
 
 
 ## User gallery
 ## User gallery
 
 
-[BRD8 [Reddit]](https://www.reddit.com/user/BRD8/) https://www.reddit.com/r/flipperzero/comments/110062z/am_i_a_hacker_now_mom/ : 
+[BRD8 [Reddit]](https://www.reddit.com/user/BRD8/) - https://www.reddit.com/r/flipperzero/comments/110062z/am_i_a_hacker_now_mom/: 
 
 
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/user/abQXuEz.jpg" width=50% height=50%>
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/user/abQXuEz.jpg" width=50% height=50%>
 
 
-[Funbob235 [Reddit]](https://www.reddit.com/user/Funbob235/) https://www.reddit.com/r/flipperzero/comments/13m1qly/testing_of_the_geiger_counter/ : 
+[Funbob235 [Reddit]](https://www.reddit.com/user/Funbob235/) - https://www.reddit.com/r/flipperzero/comments/13m1qly/testing_of_the_geiger_counter/: 
 
 
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/user/testing-of-the-geiger-counter-v0-3zv9gdq4nt0b1.jpg" width=50% height=50%>
 <img src="https://github.com/nmrr/flipperzero-geigercounter/blob/main/img/user/testing-of-the-geiger-counter-v0-3zv9gdq4nt0b1.jpg" width=50% height=50%>
 
 
-[Seanclark2409 [YouTube]](https://www.youtube.com/@seanclark2409) : 
+[Seanclark2409 [YouTube]](https://www.youtube.com/@seanclark2409): 
 
 
 [![Watch the video](https://img.youtube.com/vi/JQB2jvY1oZ0/maxresdefault.jpg)](https://youtu.be/JQB2jvY1oZ0)
 [![Watch the video](https://img.youtube.com/vi/JQB2jvY1oZ0/maxresdefault.jpg)](https://youtu.be/JQB2jvY1oZ0)
 
 
 ## What's next ?
 ## What's next ?
 
 
-Here are some nice ideas to improve this app :
+Here are some nice ideas to improve this app:
 
 
 * ~~Save output data in XML / JSON file~~ **DONE !** Output data are stored in CSV (lighter than XML / JSON and easy to parse)
 * ~~Save output data in XML / JSON file~~ **DONE !** Output data are stored in CSV (lighter than XML / JSON and easy to parse)
 * Use the geiger board as random number generator
 * Use the geiger board as random number generator
@@ -156,11 +155,11 @@ Here are some nice ideas to improve this app :
   * Data recording function has been added
   * Data recording function has been added
 
 
 * 2023-06-25
 * 2023-06-25
-  * Add zoom levels
+  * Add zoom capability
   * User gallery has been added
   * User gallery has been added
 
 
 * 2023-06-08
 * 2023-06-08
-  * Bug fixing
+  * Bug fix
 
 
 * 2023-04-11
 * 2023-04-11
   * More usable/unusable sources
   * More usable/unusable sources
@@ -175,7 +174,7 @@ Here are some nice ideas to improve this app :
 
 
 * 2023-02-02
 * 2023-02-02
   * μSv/h and mSv/y have been added
   * μSv/h and mSv/y have been added
-  * 5V pin is automatically enabled when the program is launched
+  * 5V pin is now automatically enabled when the program is launched
 
 
 * 2023-01-15
 * 2023-01-15
   * Code fix & optimizations
   * Code fix & optimizations
@@ -183,7 +182,7 @@ Here are some nice ideas to improve this app :
 
 
 * 2023-01-09
 * 2023-01-09
   * Code fix
   * Code fix
-  * Global schema was added
+  * Global schema has been added
 
 
 * 2023-01-08
 * 2023-01-08
   * Initial release
   * Initial release