Skip to content

Commit

Permalink
import user manuals
Browse files Browse the repository at this point in the history
  • Loading branch information
XdoctorwhoZ committed Jun 4, 2024
1 parent 258f1f0 commit 6affa25
Show file tree
Hide file tree
Showing 16 changed files with 410 additions and 2 deletions.
5 changes: 3 additions & 2 deletions content/docs/01_welcome/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@ You setup your test benches once in your lab then you access it in remote and sh

Great ! You can:

- Setup your test bench with Panduza
- First setup your test bench with Panduza
- Then use your freshly installed test bench or use one that someone installed for you

### I want to setup Panduza on my test bench
[`I want to setup Panduza on my test bench`]( {{< ref "docs/panduza-py/" >}})


<!-- Lab server installation section -->

Expand Down
9 changes: 9 additions & 0 deletions content/docs/10_setup-lab-server/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "Setup Lab Server"
description: "How to integrate Panduza in your lab server ?"
weight: 10
icon: "dns"
date: 2023-08-25T23:36:29+01:00
draft: false
---

18 changes: 18 additions & 0 deletions content/docs/10_setup-lab-server/introduction/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: "General Information"
description: "General steps to setup your lab server, common to any system"
date: 2023-08-25T23:36:29+01:00
draft: false
---

To enjoy Panduza, you have to install it into your Lab Server.

## Components

Here are the elements you have to install on your Lab Server.

- The Panduza Platform: Main component that will bridge you equipement with network
- Broker (optional): If you do not want to use Panduza cloud, you can start with your self-managed broker.

![](schema.png)

55 changes: 55 additions & 0 deletions content/docs/10_setup-lab-server/introduction/schema.drawio
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<mxfile host="65bd71144e">
<diagram id="0ddD8CBCVS0P4NU-PtTh" name="Page-1">
<mxGraphModel dx="1088" dy="779" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" background="#1A1A1A" math="0" shadow="0">
<root>
<mxCell id="0"/>
<mxCell id="1" parent="0"/>
<mxCell id="4" value="Lab Server" style="rounded=1;whiteSpace=wrap;html=1;horizontal=1;verticalAlign=top;fontSize=18;arcSize=0;strokeColor=#238fc8;strokeWidth=3;" parent="1" vertex="1">
<mxGeometry x="120" y="360" width="380" height="140" as="geometry"/>
</mxCell>
<mxCell id="2" value="Platform" style="rounded=1;whiteSpace=wrap;html=1;fontSize=15;" parent="1" vertex="1">
<mxGeometry x="330" y="420" width="120" height="60" as="geometry"/>
</mxCell>
<mxCell id="3" value="Self-Managed&lt;br style=&quot;font-size: 15px;&quot;&gt;Broker" style="rounded=1;whiteSpace=wrap;html=1;fontSize=15;" parent="1" vertex="1">
<mxGeometry x="170" y="420" width="120" height="60" as="geometry"/>
</mxCell>
<mxCell id="5" value="device 1" style="rounded=0;whiteSpace=wrap;html=1;fontSize=18;strokeColor=#238fc8;strokeWidth=3;" parent="1" vertex="1">
<mxGeometry x="630" y="330" width="120" height="60" as="geometry"/>
</mxCell>
<mxCell id="6" value="device 2" style="rounded=0;whiteSpace=wrap;html=1;fontSize=18;strokeColor=#238fc8;strokeWidth=3;" parent="1" vertex="1">
<mxGeometry x="630" y="400" width="120" height="60" as="geometry"/>
</mxCell>
<mxCell id="7" value="device 3" style="rounded=0;whiteSpace=wrap;html=1;fontSize=18;strokeColor=#238fc8;strokeWidth=3;" parent="1" vertex="1">
<mxGeometry x="630" y="470" width="120" height="60" as="geometry"/>
</mxCell>
<mxCell id="8" value="" style="endArrow=classic;startArrow=classic;html=1;fontSize=15;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;strokeWidth=3;" parent="1" source="4" target="5" edge="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="430" y="430" as="sourcePoint"/>
<mxPoint x="480" y="380" as="targetPoint"/>
</mxGeometry>
</mxCell>
<mxCell id="9" value="" style="endArrow=classic;startArrow=classic;html=1;fontSize=15;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;strokeWidth=3;" parent="1" source="4" target="6" edge="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="530" y="570" as="sourcePoint"/>
<mxPoint x="660" y="500" as="targetPoint"/>
</mxGeometry>
</mxCell>
<mxCell id="10" value="" style="endArrow=classic;startArrow=classic;html=1;fontSize=15;entryX=0;entryY=0.5;entryDx=0;entryDy=0;strokeWidth=3;" parent="1" target="7" edge="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="500" y="430" as="sourcePoint"/>
<mxPoint x="627" y="509" as="targetPoint"/>
</mxGeometry>
</mxCell>
<mxCell id="11" value="Network" style="ellipse;shape=cloud;whiteSpace=wrap;html=1;fontSize=15;strokeColor=#39B0FF;strokeWidth=3;" parent="1" vertex="1">
<mxGeometry x="190" y="140" width="220" height="160" as="geometry"/>
</mxCell>
<mxCell id="12" value="" style="endArrow=classic;startArrow=classic;html=1;fontSize=15;entryX=0.55;entryY=0.95;entryDx=0;entryDy=0;entryPerimeter=0;strokeWidth=3;" parent="1" source="4" target="11" edge="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="430" y="430" as="sourcePoint"/>
<mxPoint x="480" y="380" as="targetPoint"/>
</mxGeometry>
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions content/docs/10_setup-lab-server/ubuntu-server.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Linux Server"
date: 2023-08-25T23:36:29+01:00
draft: false
---

## tok

ssssssssss

## Tests

lalalalla



yayaya

## UP

qqqqq
59 changes: 59 additions & 0 deletions content/docs/10_setup-lab-server/windows-pc/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: "Windows Pc"
icon: desktop_windows
description: "Setup platform into a Windows PC"
date: 2023-08-25T23:36:29+01:00
draft: false
---

Most of electronic labs run with windows PC. Here is the page that explains how to convert it into a Panduza platform.

## Installing Mosquito MQTT Broker on Windows

Mosquito is a lightweight MQTT broker that you can use to establish a messaging infrastructure for various IoT applications. Here's a comprehensive guide to installing it on your Windows machine:

**Prerequisites:**

* A Windows computer (any version should work)
* An internet connection to download the installer

**Steps:**

1. **Download the Mosquito Installer:**

* Head over to the official Eclipse Mosquitto website: [https://mosquitto.org/download/](https://mosquitto.org/download/)
* Under the "Download" section, locate the appropriate installer for your Windows system (32-bit or 64-bit). It's usually a `.msi` file.
* Download the installer and save it to a convenient location on your computer.

2. **Run the Installer:**

* Double-click the downloaded `.msi` file to launch the Mosquito installer.
* Follow the on-screen instructions, carefully reviewing any license agreements or configuration options.
* It's recommended to keep the default installation path (`C:\mosquitto`).

3. **Start the Mosquito Broker Service:**

* Once the installation is complete, you'll have the option to launch the Mosquito broker service immediately. If you didn't choose that option, you can start it manually:
* Press the Windows key + R to open the Run dialog.
* Type `services.msc` and press Enter to open the Services window.
* Locate the "Mosquitto Broker" service in the list.
* Right-click on the service and select "Start" to begin the MQTT broker.

**Verification:**

* To confirm that Mosquito is running, you can use an MQTT client to connect to the broker. Here are a couple of popular options:
* **MQTTfx** (cross-platform desktop client): [https://mosquitto.org/download/](https://mosquitto.org/download/)
* **MQTTLens** (web-based client): [https://chrome.google.com/webstore/detail/mqttbox/kaajoficamnjijhkeomgfljpicifbkaf](https://chrome.google.com/webstore/detail/mqttbox/kaajoficamnjijhkeomgfljpicifbkaf)
* Use the following connection details in your MQTT client:
* **Broker address:** `localhost` (or your machine's IP address if connecting from another device)
* **Port:** `1883` (the default port for MQTT)

**Additional Notes:**

* If you encounter any issues during installation or configuration, refer to the official Mosquito documentation for troubleshooting steps: [https://mosquitto.org/documentation/](https://mosquitto.org/documentation/)
* Consider firewall settings if you're connecting from a different device on your network. You might need to allow incoming connections
* on port 1883.

## Install the platform

test
7 changes: 7 additions & 0 deletions content/docs/other/client-libs/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Client Libraries"
description: "How to use Panduza libs to control your lab ?"
icon: "api"
draft: false
---

24 changes: 24 additions & 0 deletions content/docs/other/client-libs/python/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: "Python Client"
description: "How to install and use Python library ?"
icon: "code"
draft: false
---



## Python Client

**Linux**

```bash
pip install "git+https://github.com/Panduza/panduza-py.git@main#egg=panduza&subdirectory=client/"
```

**Windows**

```bash
pip install "git+https://github.com/Panduza/panduza-py.git@main#egg=panduza&subdirectory=client/"
```


6 changes: 6 additions & 0 deletions content/docs/other/install-tools-to-test-device/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Install Tools To Test Device"
icon: "dns"
date: 2024-05-29T11:15:29+01:00
draft: false
---
125 changes: 125 additions & 0 deletions content/docs/other/install-tools-to-test-device/install-tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
---
title: "Install Tools"
date: 2024-05-29T11:15:29+01:00
draft: false
---


# How to start with voxpower inhibitor

### Install git :

https://github.com/git-for-windows/git/releases/download/v2.45.1.windows.1/Git-2.45.1-64-bit.exe \
(Add git path or use git cmd)

### Install python :

https://www.python.org/ftp/python/3.12.3/python-3.12.3-amd64.exe \
On the first page of install click on the "Add python.exe to PATH" button \
Finish install

### Add pip to path :

Add in your variable environment pip path (default path : C:\Python27\Scripts)

To get the python path do :
```
python
import os
import sys
os.path.dirname(sys.executable)
exit()
```

### Install Rust :

https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe \
(add path)

### Install mosquitto :

https://mosquitto.org/files/binary/win64/mosquitto-2.0.18a-install-windows-x64.exe \
(add path)

### Get platform :

```
git clone https://github.com/Panduza/panduza-rust-platform.git
```

### Get panduza-py modules :

```
pip install git+https://github.com/Panduza/panduza-py.git
```

### Get flutter app :

https://github.com/Panduza/panduza_sandbox_flutter/actions/runs/9252977096/artifacts/1540496811

### Create basic config mosquitto :

create new file, mosquitto.conf at the location you want \
add these 2 lines inside :
```
allow_anonymous true
listener 1883
```

### Start mosquitto with basic config :

```
mosquitto -c "your_path_to_mosquitto.conf/mosquitto.conf" -v
```

### Create tree.json :

tree.json path on windows : C:\Users\\"your_user_account_name"\Panduza\tree.json \
tree.json content :
```json
{
"devices": [
{
"ref": "panduza.voxpower_inhibiter",
"name": "voxpower_inhib",
"settings": {
"serial_baudrate": 9600,
"usb_vendor": "9025",
"usb_model": "0067"
}
}
]
}
```

### Create connection.json :

connection.json path on windows : C:\Users\\"your_user_account_name"\Panduza\connection.json \
content connection.json :
```json
{
"broker":
{
"addr":"localhost",
"port":1883,
"retry":1
},
"platform":
{
"name": "example"
}
}
```

### Start platform :

```
cargo run --features trac-fmt
```

### Run endurance test script with flutter app start :

Start flutter app and go add the broker with local discovery
```
python pza-py-plg-abbelight\examples\002_simple_test_voxpower_inhibiter\endurance_test_4_ping_per_5_s.py
```
8 changes: 8 additions & 0 deletions content/docs/other/introduction/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "Introduction"
description: "General information about the project"
icon: "dns"
date: 2023-08-25T23:36:29+01:00
draft: false
---

17 changes: 17 additions & 0 deletions content/docs/other/introduction/community.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "Communty"
date: 2023-08-25T23:36:29+01:00
draft: false
weight: 100
---


## Community

Everyone is welcome to join our community, you can find us on:

- [Discord](https://discord.gg/H2nSpY9AGe)
- [Github](https://github.com/Panduza)
- [Youtube](https://www.youtube.com/@panduza-tv)


Loading

0 comments on commit 6affa25

Please sign in to comment.