Skip to content

Commit 93a4ec3

Browse files
author
Luca Mazzoleni
committed
init
0 parents  commit 93a4ec3

File tree

183 files changed

+16030
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

183 files changed

+16030
-0
lines changed

.gitignore

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.pio
2+
.pioenvs
3+
.piolibdeps
4+
.vscode/.browse.c_cpp.db*
5+
.vscode/c_cpp_properties.json
6+
.vscode/launch.json
7+
.vscode/

.travis.yml

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Continuous Integration (CI) is the practice, in software
2+
# engineering, of merging all developer working copies with a shared mainline
3+
# several times a day < https://docs.platformio.org/page/ci/index.html >
4+
#
5+
# Documentation:
6+
#
7+
# * Travis CI Embedded Builds with PlatformIO
8+
# < https://docs.travis-ci.com/user/integration/platformio/ >
9+
#
10+
# * PlatformIO integration with Travis CI
11+
# < https://docs.platformio.org/page/ci/travis.html >
12+
#
13+
# * User Guide for `platformio ci` command
14+
# < https://docs.platformio.org/page/userguide/cmd_ci.html >
15+
#
16+
#
17+
# Please choose one of the following templates (proposed below) and uncomment
18+
# it (remove "# " before each line) or use own configuration according to the
19+
# Travis CI documentation (see above).
20+
#
21+
22+
23+
#
24+
# Template #1: General project. Test it using existing `platformio.ini`.
25+
#
26+
27+
# language: python
28+
# python:
29+
# - "2.7"
30+
#
31+
# sudo: false
32+
# cache:
33+
# directories:
34+
# - "~/.platformio"
35+
#
36+
# install:
37+
# - pip install -U platformio
38+
# - platformio update
39+
#
40+
# script:
41+
# - platformio run
42+
43+
44+
#
45+
# Template #2: The project is intended to be used as a library with examples.
46+
#
47+
48+
# language: python
49+
# python:
50+
# - "2.7"
51+
#
52+
# sudo: false
53+
# cache:
54+
# directories:
55+
# - "~/.platformio"
56+
#
57+
# env:
58+
# - PLATFORMIO_CI_SRC=path/to/test/file.c
59+
# - PLATFORMIO_CI_SRC=examples/file.ino
60+
# - PLATFORMIO_CI_SRC=path/to/test/directory
61+
#
62+
# install:
63+
# - pip install -U platformio
64+
# - platformio update
65+
#
66+
# script:
67+
# - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N

README.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Arduino FSM
2+
3+
This Repo provides an Example how to write a Finite-state machine (FSM) which can be nested.
4+
Based on this Wiki-Article: [Finite-state_machine](https://en.wikipedia.org/wiki/Finite-state_machine)
5+
6+
![FSM](Fsm_Moore_model_door_control.png)
7+
8+
## HowTo use Doxygen in VSCODE
9+
Check out the generated HTML-File in doc.
10+
11+
## Install Doxygen
12+
1. [Doxygen Installation manual](http://www.doxygen.nl/manual/install.html)
13+
2. Download a binary distribution at [Doxygen Download](http://www.doxygen.nl/download.html)
14+
3. Select "Full Installation" (default option)
15+
4. Add "c:/doxygen/bin" (or whatever path was used during the installation) to the System PATH variable to run "doxygen" without providing the full path to the binary.
16+
17+
[Source: [PALISADE](https://git.njit.edu/palisade/PALISADE/wikis/how-to-setup-doxygen-windows)
18+
19+
## How to run doxygen
20+
21+
1. Start the doxywizard (Desktop App)
22+
2. Click on Flle->Open and choose the Doxyfile in the Folder Doc
23+
3. In Doxywizard switch to the Tab Run and Click on Run doxygen
24+
4. When Doxygen has finished click on Show HTML output.
25+
26+
## Usefull tips
27+
### Extension for VSCode
28+
[Doxygen Documentation Generator](https://marketplace.visualstudio.com/items?itemName=cschlosser.doxdocgen)
29+
30+
Change the order in the Config-options. It's important that "author" appears befor "brief" becaus of an display error in doxygen.
31+
32+
### How to Write Doxygen Doc Comments
33+
[How to Write Doxygen Doc Comments](https://github.com/stan-dev/stan/wiki/How-to-Write-Doxygen-Doc-Comments)
34+
35+
36+
37+
38+
39+
40+
41+
42+
43+
44+

0 commit comments

Comments
 (0)