getting ready for release of 0.3.0: halbfertig.

tenbaht · tenbaht · commit 8b3002a4d43b · 2017-10-22T19:07:45.000+02:00
diff --git a/README.md b/README.md
@@ -3,12 +3,14 @@
 Getting started on the STM8 CPU the easy way by using an Arduino-like
 programming API.
 
-This project makes the most important features of the Arduino API available
-for the STM8S. It is based on free tools that are available for Linux,
-MacOS, and Windows: SDCC, make, and stm8flash.
+This project is based on free tools that are available for Linux, MacOS, and
+Windows: SDCC, make, and stm8flash. Since it's based on the SDCC Small
+Devices compiler, I called it "Small Devices -uino" or "Small-duino".
 
-Since it's based on the SDCC Small Devices compiler, I called it "Small
-Devices -uino" or "Small-duino".
+It fully integrates with the Arduino IDE or can be used
+independently (GUI-less) with very easy Makefiles based on the amazing
+[Arduino.mk makefile](https://github.com/sudar/Arduino-Makefile) by
+[Sudar](http://sudarmuthu.com>).
 
 This project is not supposed to be “better than Arduino”. It’s purpose
 is to give you a head start into a different CPU architecture if you happen
@@ -29,147 +31,85 @@ forum. It will help to catch my attention to prefix your topic with
 "[sduino]".
 
 
-## Table of Contents
-
-   * [Project Website](https://tenbaht.github.io/sduino/)
-   * [Usage example](#usage)
-   * [Supported hardware](#supported-hardware)
-   * [Why use a STM8 instead of an ATmega?](#why-use-a-stm8-instead-of-an-atmega)
-   * [Library support](#library-support)
-   * [Compatibility with the Arduino world](#compatibility-with-the-arduino-world)
-
-
-
-
-## Usage example
-
-*Preview: IDE integration is on the way now! It already works for Linux (and
-probably MacOS), Windows is to follow soon*
-
-If you have ever used the Arduino environment before you will feel at home
-right away, despite this project beeing based on a makefile rather than the
-full Arduino IDE. But don't be afraid, it is based on the amazing
-[Arduino.mk makefile](https://github.com/sudar/Arduino-Makefile) by
-[Sudar](http://sudarmuthu.com>) to control the build process, that makes
-everything very easy.
-
-First, let's make an LED blink using the Blink example from Arduino:
-
-```c
-/*
-  Blink
-  Turns on an LED on for one second, then off for one second, repeatedly.
+## Installation
 
-  This example code is in the public domain.
-*/
+Starting with version 0.3.0 automatic IDE integration is supported via the
+Arduino Boards Manager. This is the recommanded way of installation now. For
+a manual non-IDE installation please check the full [installation
+instructions](https://tenbaht.github.io/sduino/install/).
 
-#include <Arduino.h>
+Arduino IDE versions 1.8.5 and 1.6.13 are tested, but any version >=1.6.6
+should work.
 
-// Pin 13 has an LED connected on most Arduino boards.
-// Pin 3 for the STM8S103 break out board
-// give it a name:
-int led = LED_BUILTIN;
+Supported Systems:
+* Linux 64 bit: Tested on Ubuntu 16.04
+* Linux 32 bit: Tested on Ubuntu 16.04
+* Windows: Tested on Windows 7. Sduino might work on XP (not tested), but
+  the ST-Link/V2 driver is not available anymore for XP.
+* MacOS: Not tested, but should be very close to working. Will need a manual
+  install, but IDE integration should be easy now. Any volunteers?
 
-// the setup routine runs once when you press reset:
-void setup() {
-  // initialize the digital pin as an output.
-  pinMode(led, OUTPUT);
-}
+Start the Arduino-IDE. In File->Preferences, Settings tab, enter
+https://github.com/tenbaht/sduino/raw/master/package_sduino_stm8_index.json
+as an Additional Boards Manager URL.
 
-// the loop routine runs over and over again forever:
-void loop() {
-  digitalWrite(led, HIGH);   // turn the LED on (HIGH is the voltage level)
-  delay(1000);               // wait for a second
-  digitalWrite(led, LOW);    // turn the LED off by making the voltage LOW
-  delay(1000);               // wait for a second
-}
-```
+Open Tools->Board:...->Boards Manager. Find Sduino by typing 'sd' into
+the search line. Click on the list entry, Click on Install.
 
-All we need for a full build is this very basic `Makefile`:
+Now you should find a new entry "STM8S Boards" in the list at
+Tools->Board:... Choose *STM8S103F3 Breakout Board* from the list, open the
+standard Blink example from File->Examples->01. Basics->Blink and compile it
+by hitting 'Verify'.
 
-```make
-BOARD_TAG	= stm8sblue
 
-include ../../sduino/sduino.mk
-```
 
-Compile and upload it:
+### Uploading to the board
 
-	make upload
+To upload the compiled sketch to the hardware you need an ST-Link/V2
+compatible flash programmer. They are very cheap, starting at $2.50 on
+Aliexpress or eBay.
 
-Done! Your first STM8 based project is up and running!
+#### ST-Link/V2 for Linux
 
+Required lines in /etc/udev/rules.d/99-stlink.rules:
 
-## Supported hardware
+        # ST-Link/V2 programming adapter
 
-Anything with an STM8S103 or STM8S003 should work. For example, the
-70-cent-[STM8S103 breakout boards](https://tenbaht.github.io/sduino/hardware/stm8blue),
-[ESP14 Wifi boards](https://tenbaht.github.io/sduino/hardware/esp14),
-or even the [W1209 thermostat boards](https://www.aliexpress.com/wholesale?SearchText=w1209)
-that are abundant on aliexpress and Amazon. All you need to get started is a
-simple ST-Link/V2 compatible flash programmer, available for less then $3
-from China.
+        # ST-Link V1, ST-Discovery boards
+        ATTR{idVendor}=="0483", ATTR{idProduct}=="3744", MODE="0666", GROUP="pl
 
-The STM8 series by ST might be the cheapest CPUs on the market while still
-being as powerful as the ATmega series. That makes them every Chinese
-engineer's darling and chances are pretty good that you will find an '003 if
-you crack open any cheap appliance like an irrigation, temperature, or
-charging controller.
+        # ST-Link/V2, the china adapter with the green plastic housing
+        ATTR{idVendor}=="0483", ATTR{idProduct}=="3748", MODE="0666", GROUP="pl
 
-The '003 or '103 CPUs feature a 16MHz internal oscillator, 8kB flash, 1kB
-RAM and 128 or 640 byte EEPROM. They both include a UART, SPI, I2C, PWM,
-five 10 bit ADC inputs, 3 timers, and up to 14 I/O pins - quite similar to
-an Atmel ATmega8 as it was used on the first Arduino boards.
 
-Support for the more powerful
-[STM8S105 Discovery board](https://tenbaht.github.io/sduino/hardware/stm8sdiscovery)
-is very fresh, but should work now. At least Blink.c works already. These
-amazing $9 boards offer even more resources, come with a build-in flash
-programmer and are very similar to an Arduino Uno with an ATmega328 CPU.
 
-Find more information here: [Supported Boards](https://tenbaht.github.io/sduino/hardware)
+#### ST-Link/V2 for Windows
 
+Download and install the ST-Link/v2 driver **before you plug in the flash
+tool**: [STSW-LINK009 driver download]
+(http://www.st.com/en/development-tools/stsw-link009.html) (Registration
+required, but very easy)
 
 
-## Why use a STM8 instead of an ATmega?
+#### Serial upload
 
-The fairly new ESP-14 module includes a STM8S003F3P6. Wifi and a
-programmable I/O-CPU for just over two dollars - that might be the most
-compelling reason to get started on the STM8S series. Apart from pure
-curiosity and eagerness to learn something new, of course.
+Most larger STM8 CPUs (unfortunately not the popular STM8S103) even come
+with a builtin bootloader. Support for programming via a simple serial
+adapter for these devices is planned, but not implemented yet.
 
-The simple STM8S103F breakout boards are powerful and dirt cheap. They cost
-well under one dollar. You can get three boards and one flash programmer
-together for well under five dollars on http://www.aliexpress.com/ ,
-including shipping from China.
 
-The major downside is the lack of information and community support for the
-STM8. The community support and the sheer number of existing libraries for
-all kinds of sensors and hardware is outstanding in the Arduino world. If
-you just want to get something done, go for an Arduino board. Nothing will
-give you faster and easier results.
 
-For commercial use the STM8S offers some interesting advantages:
-
-**Motor control**: The STM8 has a strong focus on motor and position control
-systems. Things you need to handle yourself on an ATmega are implemented in
-hardware and work independently of the state of the software. There is even
-hardware support for quadrature encoders as used in position sensors and
-rotary encoders.
-
-**Low power modes**: The numbers in the datasheets don't look that different,
-but in real life the STM8 can be powered two or three times longer using the
-same battery capacity due to the finer control on the power modes (very,
-very careful programming required).
+## Compatibility with the Arduino world
 
-**Value for the money**: 40 to 60 cents for a STM8 with 14 I/O pins compared to
-$1.60-$3.00 for an ATmega8.
+Unfortunatly there is no free C++ compiler for the STM8. This makes it
+impossible to do a full 1:1 port of the whole enviroment as is has been done
+for the STM32 and the ESP8266.
 
-**Upgrade path**: The peripheral units of the STM8 are identical or at least
-very, very similar to the ones used with the STM32 family of 32 bit
-ARM-Cortex CPUs. This makes it is relatively easy to migrate existing
-software between the 8- and the 32-bit world. This is quite unique among the
-other CPUs.
+This is not a drop-in replacement for an AVR, but thanks to some C
+preprocessor magic the programming API is still very, very similar and it is
+often enough to just move over the opening bracket of the class
+instanciation statement and to replace the dot in a method call for an
+underscore.
 
 
 
@@ -185,24 +125,3 @@ HD44780 controller.
 
 For more sophisticated output there are libraries for Nokia-5110-type
 graphical LCDs and SSD1306-based graphical OLED displays.
-
-
-
-## Compatibility with the Arduino world
-
-I adopted the Arduino core functionality for the STM8S to set up a simple
-programming environment. But unfortunatly there is no free C++ compiler
-for these CPUs. This makes it impossible to do a full port of the whole
-enviroment and integrate it with the Arduino IDE and build system as it
-has been done for the STM32 and the ESP8266.
-
-This is not a drop-in replacement for an AVR, but the programming API is
-still very, very similar. Thanks to some C preprocessor magic it is often
-enough to just move over the opening bracket of the class instanciation
-statement and to replace the dot in a method call for an underscore.
-
-The whole Arduino build system is deeply based on the assumption of
-processing C++ source files. I am not sure if it would be even possible to
-configure a build process based only on C files without modifing the IDE
-sources. This makes a full IDE integration very unlikely.
-
diff --git a/board-manager/gen_platform_entry.sh b/board-manager/gen_platform_entry.sh
@@ -65,7 +65,7 @@ list_boards()
 
 cat << EOF
 {
-	"name": "Sduino test core",
+	"name": "Sduino STM8 plain C core (non-C++)",
 	"architecture": "stm8",
 	"version": "$COREVERSION",
 	"category": "Contributed",
diff --git a/board-manager/gen_tools_entry.sh b/board-manager/gen_tools_entry.sh
@@ -32,17 +32,20 @@ VERSION=$2
 ### helper functions #####################################################
 
 # format ID information for a file
+#
+# usage: print_filedata filename
+#
 print_filedata()
 {
 	URL=file://$(realpath $1)
 	FILENAME=$(basename "$1")
 	SIZE=$(stat --printf="%s" $1)
 	CHKSUM=$(shasum -a 256 $1|cut "-d " -f1)
-cat << EOF
-	"url": "$URL",
-	"archiveFileName": "$FILENAME",
-	"checksum": "SHA-256:$CHKSUM",
-	"size": "$SIZE"
+	cat << EOF
+                            "url": "$URL",
+                            "archiveFileName": "$FILENAME",
+                            "checksum": "SHA-256:$CHKSUM",
+                            "size": "$SIZE"
 EOF
 }
 
diff --git a/docs/hardware/flashtool.md b/docs/hardware/flashtool.md
@@ -48,7 +48,7 @@ SWD):
 
 ## Installation for Linux
 
-For Linux: required lines in /etc/udev/rules.d/99-stlink.rules:
+Required lines in /etc/udev/rules.d/99-stlink.rules:
 
 	# ST-Link/V2 programming adapter
 
@@ -59,6 +59,16 @@ For Linux: required lines in /etc/udev/rules.d/99-stlink.rules:
 	ATTR{idVendor}=="0483", ATTR{idProduct}=="3748", MODE="0666", GROUP="plugdev"
 
 
+
+## Installation for Windows
+
+Download and install the ST-Link/v2 driver **before you plug in the flash
+tool**:
+[STSW-LINK009 driver download](http://www.st.com/en/development-tools/stsw-link009.html)
+(Registration required, but very easy)
+
+
+
 ## Connection to the CPU board
 
 The pinout of the SWIM connector P3 on my STM8S103 breakout board fits the
diff --git a/package_sduino_stm8_index.json b/package_sduino_stm8_index.json
@@ -0,0 +1,93 @@
+{
+    "packages": [
+        {
+            "name": "sduino",
+            "maintainer": "Tenbaht",
+            "websiteURL": "https://tenbaht.github.io/sduino/",
+            "email": "michael-mayer@gmx.de",
+            "help": {
+                "online": "http://www.stm32duino.com/viewforum.php?f=52"
+            },
+            "platforms" : [
+{
+	"name": "Sduino STM8 plain C core (non-C++)",
+	"architecture": "stm8",
+	"version": "0.3.0-pre.1",
+	"category": "Contributed",
+	"boards": [
+		{"name": "STM8S103F3 Breakout Board"},
+		{"name": "STM8S105C6 Discovery Board"}
+	],
+	"toolsDependencies": [
+		{
+			"name": "STM8Tools",
+			"version": "2017.10.21",
+			"packager": "sduino"
+		},
+		{
+			"name": "sdcc",
+			"version": "build.10088",
+			"packager": "sduino"
+		}
+	],
+	"url": "https://github.com/tenbaht/just_a_test/releases/download/v0.1/sduino-core-0.3.0-pre.1.tar.bz2",
+	"archiveFileName": "sduino-core-0.3.0-pre.1.tar.bz2",
+	"checksum": "SHA-256:5e3b2b950954e1004ef78084063374c59b37f682ba43f1789bc40d66d88e9994",
+	"size": "4261038"
+}
+            ],
+            "tools" : [
+                {
+                    "name": "STM8Tools",
+                    "version": "2017.10.21",
+                    "systems": [
+                        {
+                            "host": "i686-pc-linux-gnu",
+                            "url": "https://github.com/tenbaht/just_a_test/releases/download/v0.1/sduino-tools_linux32-2017.10.21.tar.bz2",
+                            "archiveFileName": "sduino-tools_linux32-2017.10.21.tar.bz2",
+                            "checksum": "SHA-256:5f10d3de3e044e03160e63252ed818754c177afe5e9b5ce73a656f779193cffe",
+                            "size": "44516"
+                        },{
+                            "host": "x86_64-pc-linux-gnu",
+                            "url": "https://github.com/tenbaht/just_a_test/releases/download/v0.1/sduino-tools_linux64-2017.10.21.tar.bz2",
+                            "archiveFileName": "sduino-tools_linux64-2017.10.21.tar.bz2",
+                            "checksum": "SHA-256:0943f76ad2a7eef325e1ab858212c2413123521768ea9a06f946a2b238e0a100",
+                            "size": "49065"
+                        },{
+                            "host": "i686-mingw32",
+                            "url": "https://github.com/tenbaht/just_a_test/releases/download/v0.1/sduino-tools_mingw32-2017.10.21.tar.bz2",
+                            "archiveFileName": "sduino-tools_mingw32-2017.10.21.tar.bz2",
+                            "checksum": "SHA-256:dfdc7364a0d6749d3d1693ce5b5311ace4d80425225c98a90c5c527e375d1ecd",
+                            "size": "5541472"
+                        }
+                    ]
+                },
+                {
+                    "name": "sdcc",
+                    "version": "build.10088",
+                    "systems": [
+                        {
+                            "host": "x86_64-pc-linux-gnu",
+                            "url": "https://github.com/tenbaht/just_a_test/releases/download/v0.1/sdcc-stm8-amd64-unknown-linux2.5-20171020-10088.tar.bz2",
+                            "archiveFileName": "sdcc-stm8-amd64-unknown-linux2.5-20171020-10088.tar.bz2",
+                            "checksum": "SHA-256:dce37df6f57f6264e6b705cf7ce394d9b4407dba53c4071e77bfa34f746599a6",
+                            "size": "2486676"
+                        },{
+                            "host": "i686-pc-linux-gnu",
+                            "url": "https://github.com/tenbaht/just_a_test/releases/download/v0.1/sdcc-stm8-i386-unknown-linux2.5-20171020-10088.tar.bz2",
+                            "archiveFileName": "sdcc-stm8-i386-unknown-linux2.5-20171020-10088.tar.bz2",
+                            "checksum": "SHA-256:5237465f22f62beb69c62a14adf1e1140fe12fc29060329c61516c11fe4bacf2",
+                            "size": "2606938"
+                        },{
+                            "host": "i686-mingw32",
+                            "url": "https://github.com/tenbaht/just_a_test/releases/download/v0.1/sdcc-stm8-i586-mingw32msvc-20171020-10088.tar.bz2",
+                            "archiveFileName": "sdcc-stm8-i586-mingw32msvc-20171020-10088.tar.bz2",
+                            "checksum": "SHA-256:2c9db6ff4d2f7b7b608f956adbc06e24ac8ec4dd4f41f26c79c48f9ddecb22a5",
+                            "size": "2973875"
+                        }
+                    ]
+                }
+            ]
+        }
+    ]
+}
diff --git a/sduino/hardware/sduino/stm8/platform.txt b/sduino/hardware/sduino/stm8/platform.txt

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ list_boards()`
`65`	`65`
`66`	`66`	`cat << EOF`
`67`	`67`	`{`
`68`		`- "name": "Sduino test core",`
	`68`	`+ "name": "Sduino STM8 plain C core (non-C++)",`
`69`	`69`	`"architecture": "stm8",`
`70`	`70`	`"version": "$COREVERSION",`
`71`	`71`	`"category": "Contributed",`