Include esper into build container

Author: fooker

.travis.yml

@@ -5,7 +5,7 @@ services:
 
 before_script:
   - cp Configuration.mk.example Configuration.mk
-  - docker build --tag esper-build ./contrib/build-container
+  - docker build --tag esper-build .
 
 script:
   - docker run -it --rm --volume $(pwd):/home/builder/site --volume $(pwd):/home/builder/esper esper-build

CHANGELOG.md

@@ -3,7 +3,9 @@
 ## Unreleased
 ### Breaking changes
 - `PulseFeature` has ben renamed to `Pulse`
-- `UPDATE_TOPIC` is now hardcoded to `${MQTT_REALM}/update`. 
+- `UPDATE_TOPIC` is now hardcoded to `${MQTT_REALM}/update`.
+- Docker file moved to project root.
+- Build output moved from esper directory to site directory.
 
 ### Features
 - Added `${MQTT_REALM}/${DEVICE_ID}/status` containing `ONLINE` or `OFFLINE`

contrib/build-container/Dockerfile Dockerfilecontrib/build-container/Dockerfile renamed to Dockerfile

@@ -60,11 +60,16 @@ RUN git clone https://github.com/SmingHub/Sming.git /home/builder/Sming \
 ENV COM_PORT /dev/ttyESP
 ENV COM_SPEED 115200
 
-ENV ESPER /home/builder/esper
-ENV SITE /home/builder/site
+# Copy local esper
+COPY . /home/builder/esper/
 
+# Switch back user and set workdir for building
 USER root
 WORKDIR /home/builder/esper
 
+# Set variables for build
+ENV ESPER /home/builder/esper
+ENV SITE /home/builder/site
+
 CMD make
 

Makefile

@@ -9,7 +9,7 @@ endif
 
 
 export BUILDDIR = $(BASEDIR)/build
-export DISTDIR = $(BASEDIR)/dist
+export DISTDIR = $(SITEDIR)/dist
 
 
 # Find devices

README.md

@@ -10,7 +10,8 @@ For easy management, devices publish current status information and can be updat
 
 ## Requirements
 
-For build, ESPer requires [Sming](https://github.com/SmingHub/Sming) to be installed. We recommend using our Docker Image (`esperhub/esper`), which already contains all required dependencies.
+For build, ESPer requires [Sming](https://github.com/SmingHub/Sming) to be installed.
+We recommend using our Docker Image (`esperhub/esper`), which already contains all required dependencies.
 
 During runtime, a 2.4GHz WiFi Network with WPA or WPA2 encryption is required.
 It is highly recommended to use a separated network for ESPer based devices to limit the broadcast and multicast traffic.
@@ -25,17 +26,11 @@ Depending on the features used, some services must be provided in the environmen
 
 ### Create a site directory
 Create a project directory and initialize it as `git` repository:
-~~~~
+```
 mkdir my-site
 cd my-site
 git init
-~~~~
-
-### Add ESPer Repository
-Add the ESPer framework repository as submodule:
-~~~~
-git submodule add https://github.com/esper-hub/esper.git
-~~~~
+```
 
 ### Create environment configuration
 Then copy `esper/Configuration.mx.example` to `./Configuration.mk` and change it according to the target environment.
@@ -49,15 +44,58 @@ has several examples you can draw inspiration from.
 
 ### Build the firmware
 Execute the makefile in the ESPer directory while specifying esper and site directory:
-~~~~
-docker run -it --rm --volume /home/user/esper-site:/home/builder/site --volume /home/user/esper-site/esper:/home/builder/esper esperhub/esper:latest
-~~~~
-The resulting images will be in `/home/user/esper-site/esper/dist`.
+```shell
+docker run \
+    --tty \
+    --interactive \
+    --device ${DEVICE}:/dev/ttyESP \
+    --volume ${SITE}:/home/builder/site \
+    esperhub:esper
+```
+Replace `${DEVICE}` and `${SITE}` with the correct paths.
+
+The resulting images will be in `${SITE}/dist`.
 
 ### Flash the firmware
-Connect the ESP to your computer and boot it into the flash mode. Then execute the following command:
-~~~~
-docker run -it --rm --volume /home/user/esper-site:/home/builder/site --volume /home/user/esper-site/esper:/home/builder/esper esperhub/esper:latest make mydev/flash
-~~~~
+Connect the ESP to your computer and boot it into the flash mode. Then append the folllowing to the docker command above:
+```
+make mydev/flash
+```
+
 Once flashed the container will attach to the ESPs terminal.
 
+## Docker build-container
+The build-container allows to build ESPer in a defined environment.
+It is available at `esperhub/esper` with tags `latest` (master branch) and `develop`.
+
+### Build the docker container (optional):
+```shell
+docker build --tag esperhub/builder:local .
+```
+This must be done only once after updating the container.
+
+### Run the docker container
+```shell
+docker run \
+    --tty \
+    --interactive \
+    --device ${DEVICE}:/dev/ttyESP \
+    --volume ${SITE}:/home/builder/site \
+    esperhub:esper
+```
+Replace `${DEVICE}` and `${SITE}` with the correct paths.
+
+### Development
+
+This container can also be used for development of esper itself.
+To do so, the local esper repository can be mounted into the container by adding another the following parameter:
+
+```shell
+docker run \
+    ... \
+    --volume ${ESPER}:/home/builder/esper \
+    ... \
+```
+
+This will override the bundled esper version with the local one.
+