semvec/pypi-packages huggingface dataset:
yks 0.0.9
A sample project
Requires Python: >=3.6
Keywords: sample

# Yks

### An experiment on setting up a Python project.

[![Build Status](https://travis-ci.com/tonikarppi/yks.svg?branch=master)](https://travis-ci.com/tonikarppi/yks)

This project does not really do anything practical. It's a test for properly configuring a modern Python project with testing and Continuos Integration.

## Installation

This project is available for installation on PyPI.

```
pip install yks
```
elu-core 0.1.0
This package controls the hardware

# Eingebettete Systeme ELU core

1. [Einleitung](#Einleitung)
1. [Modul](##Modul)
1. [Github](#Github)
1. [Pip3](#Pip3)
1. [Optional](#Optional)

## Einleitung

Das Projekt "Elektronische Lastenunterstützung" (ELU) ist im Rahmen des Studiummodules "Eingebettete Systeme" entstanden.

Das Projekt soll Menschen helfen, die nicht mehr in der Lage sind schwer Lasten/Objekte zu tragen.

Auf den Roboter muss lediglich die "Last" abgelegt werden.

Anschließend kann über die Handyapp der Roboter gesteuert werden.

Mögliche Einsatzgebiete sind:

- Transport von Getränkekisten oder Einkaufstaschen
- Transport von Blumen, Erde und weitere Artikel die zur Gartenarbeit benötigt werden


## Modul

Dieses Modul ist eins von insgesammt drei Komponenten, welches für die 
die Steuerung der Hardware zuständig ist.

Das Projekt zielt darauf ab auf einem Raspberry Pi lauffähig zu sein.

Das Modul wurde auf einem Raspberry Pi 3b+ getestet.


## Modul starten

Das Projekt kann über Github oder Pip3 heruntergeladen und genutzt werden.

### Github

1. Das Projekt mit dem Befehl

   ```bash
   git clone git@github.com:MaFa961/Eingebettete_Systeme_ELU_core.git
   ```

   herunterladen.

1. Anschließend in das Projektverzeichnis wechseln

   ```bash
   cd Eingebettete_Systeme_ELU_core
   ```

1. Das Core Modul wird mit dem Konsolenbefehl

   ```bash
   ./run.sh
   ```

   gestartet.

1. Es muss sichergestellt werden, 

   das das Server Modul ebenfalls gestartet wurde.

   https://github.com/MaFa961/Eingebettete_Systeme_ELU_Server

### Pip3

1. Installieren von virtualenv

   ```bash
   pip3 install virtualenv
   ```

1. Ein Projektverzeichnis erstellen und in das Verzeichnis wechseln

   ```bash
   mkdir project_folder && cd project_folder
   ```

1. Die virtualenv starten

   ```bash
   virtualenv venv
   ```

1. Das vitrualenv aktivieren

   ```bash
   source venv/bin/activate
   ```

1. Eine requirements.txt erstellen und Abhängigkeiten einfügen

   ```bash
   echo "
   elu_core
   RPi.GPIO==0.6.4
   requests" >> requirements.txt
   ```

1. Die Abhängigkeiten installieren

   ```bash
   pip3 install -r requirements.txt
   ```

1. Das Projekt importieren und nutzen.

   Dies funktioniert nur auf einem Raspberry Pi.

   ```python
   import elu_core.main

   elu_core.main.startCore()
   ```

## Optional:

Für den Fall, dass nach dem herunterladen von Github das `run.sh` Script nicht ausführbar ist,
 muss folgender Befehl eingegeben werden:

```bash
chmod +x run.sh
```

gegebenenfalls muss das Ganze mit 

```bash
sudo
```

ausgeführt werden.
elu-server 0.1.0
This package handle the communication between smartphone app and hardware module

# Eingebettete_Systeme_ELU_core

1. [Einleitung](#Einleitung)
1. [Modul](##Modul)
1. [Github](#Github)
1. [Pip3](#Pip3)
1. [Optional](#Optional)

## Einleitung

Das Projekt "Elektronische Lastenunterstützung" (ELU) ist im Rahmen des Studiummodules "Eingebettete Systeme" entstanden.

Das Projekt soll Menschen helfen, die nicht mehr in der Lage sind schwer Lasten/Objekte zu tragen.

Auf den Roboter muss lediglich die "Last" abgelegt werden.

Anschließend kann über die Handyapp der Roboter gesteuert werden.

Mögliche Einsatzgebiete sind:

- Transport von Getränkekisten oder Einkaufstaschen
- Transport von Blumen, Erde und weitere Artikel die zur Gartenarbeit benötigt werden


## Modul

Dieses Modul ist eins von insgesammt drei Komponenten, welches für
die Kommunikation zwischen der Handyapp und des Hardwaremodules zuständig ist.

Das Projekt zielt darauf ab auf einem Raspberry Pi lauffähig zu sein.

Das Modul wurde auf einem Raspberry Pi 3b+ getestet.


## Modul starten

Das Projekt kann entweder über Github oder mit Pip3 heruntergeladen und genutzt werden.

### Github

1. Das Projekt mit dem Befehl

   `git clone git@github.com:MaFa961Eingebettete_Systeme_ELU_Server.git`

   herunterladen.

1. Anschließend in das Projektverzeichnis wechseln

   `cd Eingebettete_Systeme_ELU_Server`

1. Der Server wird mit dem Konsolen befehl

   `./run.sh`

   gestartet.

1. Es muss sichergestellt werden, 

   dass das Core Modul ebenfalls gestartet wurde.

   https://github.com/MaFa961/Eingebettete_Systeme_ELU_core

### Pip3

1. Installation von virtualenv

   `pip3 install virtualenv`

1. Ein Projektverzeichnis erstellen und in das Verzeichnis wechseln

   `mkdir project_folder && cd project_folder`

1. Die virtualenv starten

   `virtualenv venv`

1. Die vitrualenv aktivieren

   `source venv/bin/activate`

1. Install elu_server

   `pip3 install elu-server`

1. Das Projekt importieren und nutzen.

   ```python
   import server.main

   server.main.startServer()
   ```

## Optional:

Für den Fall, dass nach dem herunterladen von Github das `run.sh` Script nicht ausführbar ist, 

muss folgender Befehl eingegeben werden:

`chmod +x run.sh`

gegebenenfalls muss das Ganze mit 

`sudo`

ausgeführt werden.