summaryrefslogtreecommitdiffstats
path: root/boiler-monster/original-pic-4.2.5/readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'boiler-monster/original-pic-4.2.5/readme.txt')
-rw-r--r--boiler-monster/original-pic-4.2.5/readme.txt43
1 files changed, 43 insertions, 0 deletions
diff --git a/boiler-monster/original-pic-4.2.5/readme.txt b/boiler-monster/original-pic-4.2.5/readme.txt
new file mode 100644
index 0000000..fd5d117
--- /dev/null
+++ b/boiler-monster/original-pic-4.2.5/readme.txt
@@ -0,0 +1,43 @@
+Requirements
+============
+
+The provided files are intended to be used together with the MPLAB tools that
+can be downloaded for free form Microchip (www.microchip.com). The firmware
+has been developed on MPLAB v8.53.
+
+
+Compiling
+=========
+
+The build.cmd script can be used to build the Opentherm Gateway firmware. If
+you installed the MPLAB tools in a non-standard location, you will have to
+modify the path on the second line of the script.
+
+
+MPLAB Project
+=============
+
+If you want to create a MPLAB IDE project for the Opentherm Gateway firmare,
+you can follow these steps:
+- Go to Project -> Project Wizard.
+- Click Next
+- Select the "PIC16F88" device and click Next
+- Select the "Microchip MPASM Toolsuite" and click Next
+- Browse to the otgw-4.2.5 directory and enter gateway.mcp as the filename.
+- Click Save, then click Next
+- Add the files "gateway.asm", "selfprog.asm", "ds1820.asm" and "16f88.lkr"
+ to the project and click Next
+- Click Finish
+- Select Project -> Build Configuration -> Release
+
+The "build.asm" file is supposed to be auto-generated at the start of every
+build. The included "build.vbs" script can take care of that. To automatically
+invoke the script at the start of each build, do the following:
+- Go to Project -> Build options -> Project
+- Select the "Custom Build" tab
+- Enable the "Pre-Build Step" option
+- Specify the command line: WScript "path\to\project\dir\build.vbs"
+- Optionally add a project name as an argument on the command line
+- Click OK
+
+Now press F10 to build the project.