Recent changes to Home

Home modified by Kirill Raguzin

Kirill Raguzin — Tue, 06 May 2025 17:00:18 -0000

--- v4
+++ v5
@@ -15,7 +15,7 @@
   - If you use Linux or some other UNIX-like OS:

   Open a system shell in the OxyWitleaf2CSV project directory and enter the following command:
-  ``` bash   
+  ``` 
   ./build.sh
   ```
   - If you use Windows:
@@ -35,7 +35,7 @@

   Open a system shell in the OxyWitleaf2CSV project directory and enter the following command, replacing "patient_name" with your BIN-file name:

-  ``` bash
+  ```
   ./oxywitleaf2csv -H -f patient_name.bin > patient_name.csv
   ./csv_graph.R patient.csv
   ```

Home modified by Kirill Raguzin

Kirill Raguzin — Wed, 29 Jan 2025 13:53:08 -0000

--- v3
+++ v4
@@ -39,16 +39,17 @@
   ./oxywitleaf2csv -H -f patient_name.bin > patient_name.csv
   ./csv_graph.R patient.csv
   ```
-  Enter the following command into the console:
-  ``` R
-  input_file = "patient.csv"
-  ```

    - If you use Windows: 

   Rename the file you just got from the devie to `patient.bin` and execute the `process.bat` file. 

   Then open "R Console" and set the current directory to your OxyWitleaf2CSV project directory using the top menu or "setwd()" function. 
+  
+   Enter the following command into the console:
+  ```
+  input_file = "patient.csv"
+  ```

   Open the `csv_graph.R` file and select "Execute all" from the "Edit" menu.

Home modified by Kirill Raguzin

Kirill Raguzin — Wed, 29 Jan 2025 13:49:39 -0000

--- v2
+++ v3
@@ -39,6 +39,10 @@
   ./oxywitleaf2csv -H -f patient_name.bin > patient_name.csv
   ./csv_graph.R patient.csv
   ```
+  Enter the following command into the console:
+  ``` R
+  input_file = "patient.csv"
+  ```

    - If you use Windows: 

@@ -46,10 +50,6 @@

   Then open "R Console" and set the current directory to your OxyWitleaf2CSV project directory using the top menu or "setwd()" function. 

-  Enter the following command into the console:
-  ``` R
-  input_file = "patient.csv"
-  ```
   Open the `csv_graph.R` file and select "Execute all" from the "Edit" menu.

  5) Enjoy :).

Home modified by Kirill Raguzin

Kirill Raguzin — Mon, 16 Sep 2024 17:38:37 -0000

--- v1
+++ v2
@@ -1,8 +1,76 @@
-Welcome to your wiki!
+# OxyWitleaf2CSV  

-This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage].
+The simple program is a Witleaf handheld pulse oxymeter BIN file format data decoder. It reads BIN-files produced by popular professional pulse oxymeters manufactured by Shenzhen Witleaf Medical Electronics Co., Ltd. (like the WIT-S300 shown in the photo on the right) and produces a CSV-formatted output with the extracted data to stdout (gets printed to the console if not directed otherwise).

-The wiki uses [Markdown](/p/oxywitleaf2csv/wiki/markdown_syntax/) syntax.
+## Requirements
+ - [Digital Mars D compiler (DMD)](https://dlang.org/download.html) - required to build the BIN->CSV converter itself.
+ - [R](https://www.r-project.org/) - is used to create the graphical plots.
+
+All the required R dependancies (`plotrix` and `Cairo`) should get downloaded and installed automatically.
+
+## Preparing for use
+1) Install [DMD](https://dlang.org/download.html) according to your OS or system package manager instructions.
+2) Compile OxyWitleaf2CSV from the source file:
+   
+  - If you use Linux or some other UNIX-like OS:
+  
+  Open a system shell in the OxyWitleaf2CSV project directory and enter the following command:
+  ``` bash   
+  ./build.sh
+  ```
+  - If you use Windows:
+
+  Execute the `build_win.bat` file. 
+
+3) If you want to create plots like the one shown on the picture near the bottom of the page then install [R](https://www.r-project.org/) as well.
+ 
+## Usage
+ 1) Set up your pulse oxymeter. Don't forget to set a correct date and time as it will be used as timestamps for the data samples and some patient name as it will name a file you will use later on.
+ 2) Record some data at any sample period you want.
+ 3) Connect the device to your PC using the included MiniUSB <-> USB-A cable (the device will be detected as a general file storage).
+ 4) Copy a BIN-file with the name corresponding to the "patient's name" set up previously to the directory containing OxyWitleaf2CSV project files.
+ 5) Process the file using OxyWitleaf2CSV:
+    
+   - If you use Linux or some other UNIX-like OS:
+
+  Open a system shell in the OxyWitleaf2CSV project directory and enter the following command, replacing "patient_name" with your BIN-file name:
+   
+  ``` bash
+  ./oxywitleaf2csv -H -f patient_name.bin > patient_name.csv
+  ./csv_graph.R patient.csv
+  ```
+    
+   - If you use Windows: 
+  
+  Rename the file you just got from the devie to `patient.bin` and execute the `process.bat` file. 
+  
+  Then open "R Console" and set the current directory to your OxyWitleaf2CSV project directory using the top menu or "setwd()" function. 
+  
+  Enter the following command into the console:
+  ``` R
+  input_file = "patient.csv"
+  ```
+  Open the `csv_graph.R` file and select "Execute all" from the "Edit" menu.
+  
+ 5) Enjoy :).
+
+You will get a CSV file containing 4 columns:
+ - "Section" - recording session number;
+ - "Timestamp" - full date and time when a sample was taken (ISO 8601 "extended" timestamp format is used);
+ - "SpO2" - oxygen saturation value;
+ - "PR" - pulse rate;
+
+The field separator used is ";".
+
+If you have Microsoft Office 2010 or above, then it is recommended to use LibreOffice as it allows you to choose an appropriate field separator and column format.
+
+You will also get a PNG picture for each recording session named "plot1.png" to "plotN.png" where "N" is the number of recordings available in the BIN file. Each picture will look somewhat like this:
+
+
+
+If you want smoother graphics with anti-aliasing enabled you can open the "csv_graph.R" file and replace the line ```use_Cairo = FALSE``` with ```use_Cairo = TRUE``` and run the "csv_graph.R" script again to see if the results are more appealing.
+
+The files should be enough to compose your report.

 [[members limit=20]]
 [[download_button]]

Home modified by Kirill Raguzin

Kirill Raguzin — Mon, 16 Sep 2024 17:32:21 -0000

Welcome to your wiki!

This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage].

The wiki uses Markdown syntax.

Project Members:

Kirill Raguzin (admin)