github.com/UtilitechAS.amsreader-firmware
1
0
Fork 0
mirror of https://github.com/UtilitechAS/amsreader-firmware.git synced 2026-01-15 08:22:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Moved getting started to individual file

Browse Source
This commit is contained in:
Roar Fredriksen 2018-03-01 21:15:46 +01:00
parent cda037b159
commit 7bd0868c54
2 changed files with 58 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
Electrical/GETTING_STARTED.md Normal file
View File

@ -0,0 +1,55 @@
# Getting started building or modifying
## Tools
### Kicad
Install the [KiCad](http://www.kicad-pcb.org/) program to edit the schematic or PCB.
KiCad documentation and forums:
* https://kicad-pcb.org/help/documentation/#_getting_started
* https://forum.kicad.info/
* https://www.reddit.com/r/KiCad/
* https://en.wikipedia.org/wiki/KiCad
### Simulator
If you want to simulate parts of the circuit you also need a simulator. This is
highly recommended! This saves a *lot* of troubleshooting and makes you find
solutions you otherwise would not have found.
[Electronic circuit simulation](https://en.wikipedia.org/wiki/Electronic_circuit_simulation)
using computers have a long history. Many of them have origins directly or indirectly
related to the classic SPICE simulator (e.g. [Ngspice](http://ngspice.sourceforge.net)).
At the core they work similar to source code compilers - you give it a text file
describing the circuit and it produces a textual simulation result. Some of the simulators
are intended to be used just in text mode while other have a graphical frontend where
you are able to draw the circuit like in a schematic editor:
* [QUCS](http://qucs.sourceforge.net/) - Quite Universal Circuit Simulator.
* [QUCS-S](https://ra3xdh.github.io/) - A qucs version using ngspice as simulation backend. This one has been used for the simulations for board 3.
* [eSim](http://esim.fossee.in/).
* [Other alternatives](https://en.wikipedia.org/wiki/List_of_free_electronics_circuit_simulators).
### Git
While it is possible to download the content from this repository as a compresset
zip file, you want to use git to fetch the content. For Linux install depending on
distribution with
```
apt-get install git # debian, ubuntu, etc
dnf install git # fedora
yum install git # rhel, centos
```
For windows the most convenient option is to install [git for windows](https://git-scm.com/download/win).
To download the source of this repository run:
```
git clone https://github.com/roarfred/AmsToMqttBridge
cd AmsToMqttBridge
git submodule init
git submodule update --recursive
```

60
Electrical/README.md
View File

@ -3,6 +3,8 @@
Here are links to the different board designs together with a short summary.
## HAN_ESP_Simple (Was: Board 1)
The project's original [board design](HAN_ESP_Simple). It
@ -40,60 +42,4 @@ AMS unit.
Implementation done.
# Getting started building or modifying
## Tools
### Kicad
Install the [KiCad](http://www.kicad-pcb.org/) program to edit the schematic or PCB.
KiCad documentation and forums:
* https://kicad-pcb.org/help/documentation/#_getting_started
* https://forum.kicad.info/
* https://www.reddit.com/r/KiCad/
* https://en.wikipedia.org/wiki/KiCad
### Simulator
If you want to simulate parts of the circuit you also need a simulator. This is
highly recommended! This saves a *lot* of troubleshooting and makes you find
solutions you otherwise would not have found.
[Electronic circuit simulation](https://en.wikipedia.org/wiki/Electronic_circuit_simulation)
using computers have a long history. Many of them have origins directly or indirectly
related to the classic SPICE simulator (e.g. [Ngspice](http://ngspice.sourceforge.net)).
At the core they work similar to source code compilers - you give it a text file
describing the circuit and it produces a textual simulation result. Some of the simulators
are intended to be used just in text mode while other have a graphical frontend where
you are able to draw the circuit like in a schematic editor:
* [QUCS](http://qucs.sourceforge.net/) - Quite Universal Circuit Simulator.
* [QUCS-S](https://ra3xdh.github.io/) - A qucs version using ngspice as simulation backend. This one has been used for the simulations for board 3.
* [eSim](http://esim.fossee.in/).
* [Other alternatives](https://en.wikipedia.org/wiki/List_of_free_electronics_circuit_simulators).
### Git
While it is possible to download the content from this repository as a compresset
zip file, you want to use git to fetch the content. For Linux install depending on
distribution with
```
apt-get install git # debian, ubuntu, etc
dnf install git # fedora
yum install git # rhel, centos
```
For windows the most convenient option is to install [git for windows](https://git-scm.com/download/win).
To download the source of this repository run:
```
git clone https://github.com/roarfred/AmsToMqttBridge
cd AmsToMqttBridge
git submodule init
git submodule update --recursive
```
Please also see [Getting started building or modifying](GETTING_STARTED.md)