Skip to content

Commit

Permalink
Project description updated
Browse files Browse the repository at this point in the history
  • Loading branch information
TG9541 committed Nov 26, 2017
1 parent ec10535 commit e08f5bf
Showing 1 changed file with 30 additions and 8 deletions.
38 changes: 30 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,54 @@

[![Travis-CI](https://travis-ci.org/TG9541/W1209.svg?branch=master)](https://travis-ci.org/TG9541/stm8ef)

This project uses [STM8EF](https://github.com/TG9541/stm8ef) to turn an off-the-shelf [W1209][] into a data logging thermostat.
This project uses [STM8EF](https://github.com/TG9541/stm8ef) to turn an off-the-shelf [W1209][] into a data logging thermostat.

This is work in progress. There is a [HACKADAY.IO project][HAD1] where progress is tracked.
Features are:

* heating thermostat, e.g. for building chicken egg incubators
* basic sensor failure detection
* parameters for set-point, hysteresis, and trip-delay
* easy to use parameters menu (no need to search for a manual!)
* temperature logger with 0.1h to 10h intervall, and a 288 entry ring-buffer
* logger access throug a serial console
* fully programmable in Forth, even while it's running!

Although it's feature-complete, this is work in progress:

* Beta-grade "bleeding edge"
* not even an "endurance run" yet

Planned features:

* Improved logger with min/max temperature, and heating duty cycle
* Field-bus feature for thermostats
* more fail-safe features (parameter integrity, maybe a buzzer)

Please check out the [HACKADAY.IO project][HAD1]!

## Getting Started

The GitHub releases page contains a

## Building the Source code

The Makefile provides a dependency resolution feature that downloads an STM8 eForth binary release, and adds the required folders, files, and symlinks to the base folder.

For [programming the W1209 binary](https://github.com/TG9541/W1209/blob/master/out/W1209-FD/W1209-FD.ihx) please follow the instructions in the [STM8EF Wiki page for board W1209](
https://github.com/TG9541/stm8ef/wiki/Board-W1209#flashing-the-stm8ef-binary), or just type `make flash`.

Interactive scripting through the serial console is supported once the base STM8 eForth system has been flashed to the board. Please refer to the [instructions for getting a serial console](https://github.com/TG9541/stm8ef/wiki/Board-W1209#serial-communication-through-the-key-pins).

The recommended terminal emulator is [e4thcom](https://wiki.forth-ev.de/doku.php/en:projects:e4thcom): it supports line editing, and upload of source files with `#include`, and using a library with `#require`.
The recommended terminal emulator is [e4thcom](https://wiki.forth-ev.de/doku.php/en:projects:e4thcom): it supports line editing, and upload of source files with `#include`, and using a library with `#require`. Just type `#i main.fs` to load the complete source code!

The `make simload` uses ucSim to create an STM8 binary file that contains the full thermostat script, including the W1209-FD base image. The Docker image [tg9541/docker-sdcc](https://hub.docker.com/r/tg9541/docker-sdcc/) contains tool dependencies for Continuous Integration (refer to `.travis.yml`).
For Continuous Integration, `make simload` uses ucSim to create an STM8 binary file that contains the full thermostat script, including the W1209-FD base image. The Docker image [tg9541/docker-sdcc](https://hub.docker.com/r/tg9541/docker-sdcc/) contains tool dependencies for Continuous Integration (refer to `.travis.yml`).

## Using this repository

[![asciicast](https://asciinema.org/a/M4fFDCSQeaNFDGM64781kMYmm.png)](https://asciinema.org/a/M4fFDCSQeaNFDGM64781kMYmm)

* clone the repository
* install [stm8flash](https://github.com/vdudouyt/stm8flash)
* [connect a ST-LINK-V2 dongle to a W1209][W1209]
* run `make defaults` to wipe the stock firmware
* run `make defaults` to wipe the stock firmware
* warning: there is no known public source for the stock firmware, and after erasing it there is no way back!
* run `make` to flash the STM8EF binary
* for interactive scripting install [e4thcom](
Expand All @@ -47,4 +70,3 @@ And above all: please write about it in forums, blogs, or on Twitter (please use

[HAD1]: https://hackaday.io/project/26258-w1209-data-logging-thermostat
[W1209]: https://github.com/TG9541/stm8ef/wiki/Board-W1209

0 comments on commit e08f5bf

Please sign in to comment.