Skip to content

Commit 5a48fd8

Browse files
authored
Update README.md
1 parent 7b60273 commit 5a48fd8

File tree

1 file changed

+36
-4
lines changed

1 file changed

+36
-4
lines changed

README.md

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,36 @@
11
# LHe-Level-Meter
2-
Firmware of liquid He monitors
32

3+
Firmware of liquid He monitors, that monitor the level of He dewers. They are meant to be used in conjunction with [Helium Management](https://github.com/SampleEnvironment/Helium-Management) application.
44

5-
### Build configurations:
5+
## Getting started
6+
### Requisities
7+
In order to start developing/testing/flashing Firmware you will need:
8+
- [Microchip Studio](https://www.microchip.com/en-us/tools-resources/develop/microchip-studio)
9+
- A debugger for example *Atmel Power debugger*
10+
- Levelmeter
11+
12+
13+
14+
### Preparations
15+
Before first compiling the project in Microchip Studio the submodule of the avr-library needs to be initialized:
16+
```
17+
git submodule update --init
18+
```
19+
20+
### Choosing a Release
21+
In order to generate a executable Firmware of a specific release, `git tag` will list all available releases and
22+
```git checkout --recurse-submodules vX.XXX```
23+
will load the release specified by `vX.XXX` (for example `v1.221`).
24+
25+
### Build configurations (from v1.219):
26+
Build configurations are used to generate firmware binarys that are meant for the same device Type, but with varying Hardware, for example the display that is used. Build configuration names for Levelmeter have the following Format `'DisplayType'-'DisplayConfiguration'` and can be set via the dropdown menu depicted in the screenshot below.
27+
28+
![build_configurationslvlmeter](https://user-images.githubusercontent.com/85115389/203858797-030be3e1-eace-49d6-90cc-699f5324b870.png)
29+
30+
31+
32+
Buildconfigurations have the following Format ```'DisplayType'-'DisplayConfiguration'```. All different configurations are listed and described in the tables below:
633

7-
Buildconfigurations have the following Format:
8-
```'DisplayType'-'DisplayConfiguration'```
934

1035
| Display Type | Description |
1136
|--------------|--------------------------------------------------------|
@@ -16,3 +41,10 @@ Buildconfigurations have the following Format:
1641
|-------------------|---------------------------------------------------------------------------------------------------------|
1742
| Default | Default Display Configuration |
1843
| ILL | Disply is rotated 180° in ILL Levelmeters, because a different Case is used |
44+
45+
46+
47+
### Manual
48+
49+
For further Information please refer to the [wiki](https://github.com/SampleEnvironment/LHe-Level-Meter/wiki/) pages
50+

0 commit comments

Comments
 (0)