Skip to content

svensson84/aareck

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

aareck

stable-release-shields.io-url npm-shields.io-url git-shields.io-url gloc-shields.io-url license-shields.io-url

aareck -- aare check Reports hydrometric and weather data from the most beautiful river in Switzerland named "Aare".

Table of Contents

  1. About
  2. Build
  3. Run
  4. Examples
  5. Documentation
  6. Acknowledgements
  7. Sources
  8. Copyright

About

aareck -- aare check is a C program (CLI) for unix/linux systems. aareck reports hydrometric and weather data from the most beautiful river in Switzerland named "Aare".

Build

Prerequisites

aareck depends on following C libraries:

  1. libcurl >=7.87.0
  2. json-c-0.16-20220414

Build Commands

git clone https://github.com/svensson84/aareck.git ~/aareck
cd ~/aareck
sudo make
sudo make install

Run

aareck

Examples

List cities of all measuring stations

aareck -l

example 1

Figure 1: Example 1 aareck -l (Source: Zaugg S., 2022)

Report hydrometric measurements from city brienz with colorized output

aareck -hCc brienz

example 2

Figure 2: Example 2 aareck -hCc brienz (Source: Zaugg S., 2022)

Report mixed measurements from multiple cities with colorized output

aareck -mCc 'thun biel brugg'

example 3

Figure 3: Example 3 aareck -mCc 'thun biel brugg' (Source: Zaugg S., 2022)

Report weather forecast for city bern with colorized output

aareck -wCc bern

example 4

Figure 4: Example 4 aareck -wCc bern/i> (Source: Zaugg S., 2022)

Documentation

Architecture

Public Interface Declarations

Figure 5 shows aareck's public interface declarations. Changes in those interface declarations lead to new major realeases x.0.0 (semantic versioning)

uml diagram
Figure 5: uml data diagram for public interface declarations aareck-interface.h (Source: Zaugg S., 2022)

Sequence Diagram

Figure 6 shows an exemplary sequence to retrieve measurement data of the "Aare" river.

uml diagram
Figure 6: uml sequence diagram for function show_hydrometric_data(*request) (Source: Zaugg S., 2022)

Acknowledgements

Special thanks to Christian Studer and Aare.guru GmbH for providing their Aare.guru API
I would also like to say a special thank you to Job Vranish for sharing his smart and clean Makefile

Sources

Copyright

© 2022 Sven Zaugg zaugg84@gmail.com

aareck is released under an MIT-style license; see LICENSE for details.

About

aareck -- aare check: Reports hydrometric and weather data from the most beautiful river in Switzerland named "Aare".

Resources

License

Stars

Watchers

Forks

Packages

No packages published