docs update

fossasia · Sep 22, 2018 · 90ff957 · 90ff957
1 parent eb58b7e
commit 90ff957
Show file tree

Hide file tree

Showing 34 changed files with 20 additions and 30 deletions.
diff --git a/PSLab_Original/COMMANDS.h → PSLab_V1/COMMANDS.h b/PSLab_Original/COMMANDS.h → PSLab_V1/COMMANDS.h
diff --git a/PSLab_Original/Common_Functions.c → PSLab_V1/Common_Functions.c b/PSLab_Original/Common_Functions.c → PSLab_V1/Common_Functions.c
diff --git a/PSLab_Original/Common_Functions.h → PSLab_V1/Common_Functions.h b/PSLab_Original/Common_Functions.h → PSLab_V1/Common_Functions.h
diff --git a/PSLab_Original/Function.c → PSLab_V1/Function.c b/PSLab_Original/Function.c → PSLab_V1/Function.c
diff --git a/PSLab_Original/Function.h → PSLab_V1/Function.h b/PSLab_Original/Function.h → PSLab_V1/Function.h
diff --git a/PSLab_Original/Makefile → PSLab_V1/Makefile b/PSLab_Original/Makefile → PSLab_V1/Makefile
diff --git a/PSLab_Original/Measurements.c → PSLab_V1/Measurements.c b/PSLab_Original/Measurements.c → PSLab_V1/Measurements.c
diff --git a/PSLab_Original/Measurements.h → PSLab_V1/Measurements.h b/PSLab_Original/Measurements.h → PSLab_V1/Measurements.h
diff --git a/PSLab_Original/PSLAB_ADC.c → PSLab_V1/PSLAB_ADC.c b/PSLab_Original/PSLAB_ADC.c → PSLab_V1/PSLAB_ADC.c
diff --git a/PSLab_Original/PSLAB_ADC.h → PSLab_V1/PSLAB_ADC.h b/PSLab_Original/PSLAB_ADC.h → PSLab_V1/PSLAB_ADC.h
diff --git a/PSLab_Original/PSLAB_I2C.c → PSLab_V1/PSLAB_I2C.c b/PSLab_Original/PSLAB_I2C.c → PSLab_V1/PSLAB_I2C.c
diff --git a/PSLab_Original/PSLAB_I2C.h → PSLab_V1/PSLAB_I2C.h b/PSLab_Original/PSLAB_I2C.h → PSLab_V1/PSLAB_I2C.h
diff --git a/PSLab_Original/PSLAB_NRF.c → PSLab_V1/PSLAB_NRF.c b/PSLab_Original/PSLAB_NRF.c → PSLab_V1/PSLAB_NRF.c
diff --git a/PSLab_Original/PSLAB_NRF.h → PSLab_V1/PSLAB_NRF.h b/PSLab_Original/PSLAB_NRF.h → PSLab_V1/PSLAB_NRF.h
diff --git a/PSLab_Original/PSLAB_SPI.c → PSLab_V1/PSLAB_SPI.c b/PSLab_Original/PSLAB_SPI.c → PSLab_V1/PSLAB_SPI.c
diff --git a/PSLab_Original/PSLAB_SPI.h → PSLab_V1/PSLAB_SPI.h b/PSLab_Original/PSLAB_SPI.h → PSLab_V1/PSLAB_SPI.h
diff --git a/PSLab_Original/PSLAB_UART.c → PSLab_V1/PSLAB_UART.c b/PSLab_Original/PSLAB_UART.c → PSLab_V1/PSLAB_UART.c
diff --git a/PSLab_Original/PSLAB_UART.h → PSLab_V1/PSLAB_UART.h b/PSLab_Original/PSLAB_UART.h → PSLab_V1/PSLAB_UART.h
diff --git a/PSLab_Original/Wave_Generator.c → PSLab_V1/Wave_Generator.c b/PSLab_Original/Wave_Generator.c → PSLab_V1/Wave_Generator.c
diff --git a/PSLab_Original/Wave_Generator.h → PSLab_V1/Wave_Generator.h b/PSLab_Original/Wave_Generator.h → PSLab_V1/Wave_Generator.h
diff --git a/PSLab_Original/nbproject/Makefile-default.mk → PSLab_V1/nbproject/Makefile-default.mk b/PSLab_Original/nbproject/Makefile-default.mk → PSLab_V1/nbproject/Makefile-default.mk
diff --git a/PSLab_Original/nbproject/Makefile-impl.mk → PSLab_V1/nbproject/Makefile-impl.mk b/PSLab_Original/nbproject/Makefile-impl.mk → PSLab_V1/nbproject/Makefile-impl.mk
diff --git a/...ginal/nbproject/Makefile-local-default.mk → PSLab_V1/nbproject/Makefile-local-default.mk b/...ginal/nbproject/Makefile-local-default.mk → PSLab_V1/nbproject/Makefile-local-default.mk
diff --git a/..._Original/nbproject/Makefile-variables.mk → PSLab_V1/nbproject/Makefile-variables.mk b/..._Original/nbproject/Makefile-variables.mk → PSLab_V1/nbproject/Makefile-variables.mk
diff --git a/...b_Original/nbproject/Package-default.bash → PSLab_V1/nbproject/Package-default.bash b/...b_Original/nbproject/Package-default.bash → PSLab_V1/nbproject/Package-default.bash
diff --git a/PSLab_Original/nbproject/configurations.xml → PSLab_V1/nbproject/configurations.xml b/PSLab_Original/nbproject/configurations.xml → PSLab_V1/nbproject/configurations.xml
diff --git a/PSLab_Original/nbproject/project.properties → PSLab_V1/nbproject/project.properties b/PSLab_Original/nbproject/project.properties → PSLab_V1/nbproject/project.properties
diff --git a/PSLab_Original/nbproject/project.xml → PSLab_V1/nbproject/project.xml b/PSLab_Original/nbproject/project.xml → PSLab_V1/nbproject/project.xml
diff --git a/PSLab_Original/proto2_main.c → PSLab_V1/proto2_main.c b/PSLab_Original/proto2_main.c → PSLab_V1/proto2_main.c
diff --git a/README.md b/README.md
@@ -10,23 +10,35 @@ PSLab is a new addition to FOSSASIA Science Lab. This tiny pocket lab provides a
 ## Communication
 
 Please join us on the following channels:
-* [Pocket Science Channel](https://gitter.im/fossasia/pslab)
-* [Mailing List](https://groups.google.com/forum/#!forum/pslab-fossasia)
+* Pocket Science Channel https://gitter.im/fossasia/pslab
+* Mailing List https://groups.google.com/forum/#!forum/pslab-fossasia
 
 ## Basic requirements 
 
-- Microcontroller Platform : [ PIC24EP256GP204 ](http://www.microchip.com/wwwproducts/en/PIC24EP256GP204)
-- IDE : [MPLABX IDE v3.35](http://www.microchip.com/mplab/mplab-x-ide) . Supported on Linux/Windows/Mac
-- Compiler : [MPLAB® XC16 Compiler](http://www.microchip.com/mplab/compilers)
-- Programming Tool : [PICkit™ 3 In-Circuit Debugger/PICkit2](http://www.microchip.com/Developmenttools/ProductDetails.aspx?PartNO=PG164130)
+- PSLab Hardware - https://github.com/fossasia/pslab-hardware) or PIC24EP256GP204 breakout board - http://www.microchip.com/wwwproducts/en/PIC24EP256GP204
+- IDE: MPLABX IDE v3.35 Supported on Linux/Windows/Mac - http://www.microchip.com/mplab/mplab-x-ide
+- Compiler: MPLAB® XC16 Compiler - http://www.microchip.com/mplab/compilers
+- Programming Tool: PICkit™ 3 In-Circuit Debugger/PICkit2 - http://www.microchip.com/Developmenttools/ProductDetails.aspx?PartNO=PG164130
 
 ## Existing Firmware
 
-The original library and main code for PSLab version 1 are located in directories 'PSLab_Original' and 'PSLab_Original_library'.
-Please note that they must be located in the same directory during compilation via MPLABX because the former relatively imports the latter.
+Implemented features:
+-Byte Headers 
++ Flash R/W . One page at a time (2048 bytes)
++ I2C Sensors :
+  + Start , Stop, BulkTransfers, config
++ ADC :
+  + Read buffer , clear buffer
++ Sine wave :
+  + Wave tables 
++ Sine wave :
+  + Wave tables 
 
 This code is elaborately written , and special function register(SFR) bit settings are done in separate lines of code for easily tweaking. The code can be shrunk if firmware efficiency becomes a concern at any point. 
 
+The library and code for PSLab version 1 are located in directories 'PSLab_V1'. Please note that they must be located in the same directory during compilation via MPLABX because the former relatively imports the latter.
+
+
 ### Compilation and testing instructions
 
 1. Download and install the MPLab IDE & XC16 compiler from the links given above
@@ -52,25 +64,3 @@ This code is elaborately written , and special function register(SFR) bit settin
 [128189.933262] hid-generic 0003:04D8:00DF.0032: hiddev0,hidraw0: USB HID v1.11 Device [Microchip Technology Inc. MCP2200 USB Serial Port Emulator] on usb-0000:00:14.0-2/input2
 ```
 - Install and launch the [PSLab desktop app](https://github.com/fossasia/pslab-desktop-apps) by following its README
-
-
-### New Firmware
-
-Implemented feature list in new project called 'MPLab Project'
--Byte Headers 
-
-+ Flash R/W . One page at a time (2048 bytes)
-+ I2C Sensors :
-  + Start , Stop, BulkTransfers, config
-
-+ ADC :
-  + Read buffer , clear buffer
-
-+ Sine wave :
-  + Wave tables 
-+ Sine wave :
-  + Wave tables 
-
-## Hardware requirements
-
-[PSLab Hardware](https://github.com/fossasia/pslab-hardware) or PIC24EP256GP204 breakout board.
diff --git a/docs/Communication protocol.ods → docs/CommunicationProtocol.ods b/docs/Communication protocol.ods → docs/CommunicationProtocol.ods
diff --git a/docs/Partslist.pdf b/docs/Partslist.pdf
diff --git a/docs/Schematic.pdf b/docs/Schematic.pdf
diff --git a/reference docs/Communication protocol.ods b/reference docs/Communication protocol.ods