diff --git a/content/docs/01_welcome/index.md b/content/docs/01_welcome/index.md index 0ca0a95..26fb43e 100644 --- a/content/docs/01_welcome/index.md +++ b/content/docs/01_welcome/index.md @@ -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/" >}}) + diff --git a/content/docs/10_setup-lab-server/_index.md b/content/docs/10_setup-lab-server/_index.md new file mode 100644 index 0000000..55bb922 --- /dev/null +++ b/content/docs/10_setup-lab-server/_index.md @@ -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 +--- + diff --git a/content/docs/10_setup-lab-server/introduction/index.md b/content/docs/10_setup-lab-server/introduction/index.md new file mode 100644 index 0000000..f8237e1 --- /dev/null +++ b/content/docs/10_setup-lab-server/introduction/index.md @@ -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) + diff --git a/content/docs/10_setup-lab-server/introduction/schema.drawio b/content/docs/10_setup-lab-server/introduction/schema.drawio new file mode 100644 index 0000000..78b4b92 --- /dev/null +++ b/content/docs/10_setup-lab-server/introduction/schema.drawio @@ -0,0 +1,55 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/content/docs/10_setup-lab-server/introduction/schema.png b/content/docs/10_setup-lab-server/introduction/schema.png new file mode 100644 index 0000000..d9c3718 Binary files /dev/null and b/content/docs/10_setup-lab-server/introduction/schema.png differ diff --git a/content/docs/10_setup-lab-server/ubuntu-server.md b/content/docs/10_setup-lab-server/ubuntu-server.md new file mode 100644 index 0000000..cd26c4b --- /dev/null +++ b/content/docs/10_setup-lab-server/ubuntu-server.md @@ -0,0 +1,21 @@ +--- +title: "Linux Server" +date: 2023-08-25T23:36:29+01:00 +draft: false +--- + +## tok + +ssssssssss + +## Tests + +lalalalla + + + +yayaya + +## UP + +qqqqq \ No newline at end of file diff --git a/content/docs/10_setup-lab-server/windows-pc/index.md b/content/docs/10_setup-lab-server/windows-pc/index.md new file mode 100644 index 0000000..4471818 --- /dev/null +++ b/content/docs/10_setup-lab-server/windows-pc/index.md @@ -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 diff --git a/content/docs/other/client-libs/_index.md b/content/docs/other/client-libs/_index.md new file mode 100644 index 0000000..ee0c13f --- /dev/null +++ b/content/docs/other/client-libs/_index.md @@ -0,0 +1,7 @@ +--- +title: "Client Libraries" +description: "How to use Panduza libs to control your lab ?" +icon: "api" +draft: false +--- + diff --git a/content/docs/other/client-libs/python/index.md b/content/docs/other/client-libs/python/index.md new file mode 100644 index 0000000..ce4bdcc --- /dev/null +++ b/content/docs/other/client-libs/python/index.md @@ -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/" +``` + + diff --git a/content/docs/other/install-tools-to-test-device/_index.md b/content/docs/other/install-tools-to-test-device/_index.md new file mode 100644 index 0000000..8183da4 --- /dev/null +++ b/content/docs/other/install-tools-to-test-device/_index.md @@ -0,0 +1,6 @@ +--- +title: "Install Tools To Test Device" +icon: "dns" +date: 2024-05-29T11:15:29+01:00 +draft: false +--- diff --git a/content/docs/other/install-tools-to-test-device/install-tools.md b/content/docs/other/install-tools-to-test-device/install-tools.md new file mode 100644 index 0000000..7d9c50a --- /dev/null +++ b/content/docs/other/install-tools-to-test-device/install-tools.md @@ -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 +``` diff --git a/content/docs/other/introduction/_index.md b/content/docs/other/introduction/_index.md new file mode 100644 index 0000000..5d7734f --- /dev/null +++ b/content/docs/other/introduction/_index.md @@ -0,0 +1,8 @@ +--- +title: "Introduction" +description: "General information about the project" +icon: "dns" +date: 2023-08-25T23:36:29+01:00 +draft: false +--- + diff --git a/content/docs/other/introduction/community.md b/content/docs/other/introduction/community.md new file mode 100644 index 0000000..8affb0d --- /dev/null +++ b/content/docs/other/introduction/community.md @@ -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) + + diff --git a/content/docs/other/introduction/configurations.md b/content/docs/other/introduction/configurations.md new file mode 100644 index 0000000..e48bfad --- /dev/null +++ b/content/docs/other/introduction/configurations.md @@ -0,0 +1,24 @@ +--- +title: "Configurations" +description: "How to freeze your Panduza version and keep items compatibility ?" +date: 2023-08-25T23:36:29+01:00 +draft: false +weight: 50 +--- + +Configurations are stored in the repo : [panduza-conf](https://github.com/Panduza/panduza-conf) + +## Goal + +Panduza is a project composed of multiple items. + +To ensure the compatibility between all those items Panduza save its configurations. + +This also help you to easily keep the configuration ID of Panduza into your own configuration management and ensure tacibility. + +## Git-Repo + +Panduza items are all stored into Git repositories and git-repo is used to manage the configurations. + +You will find here some instructions to setup git-repo: https://github.com/esrlabs/git-repo. + diff --git a/content/docs/other/introduction/dictionary.md b/content/docs/other/introduction/dictionary.md new file mode 100644 index 0000000..e1ff0e9 --- /dev/null +++ b/content/docs/other/introduction/dictionary.md @@ -0,0 +1,15 @@ +--- +title: "Dictionary" +description: "Panduza definitions" +draft: false +weight: 300 +--- + +## Terms List + +| term | Description | +| ------------------- | ------------------------------------------------------------------------------------------ | +| Lab Server | Computer inside your lab connected to your equipements and the network | +| Panduza Cloud | Group of cloud services provided by Panduza (Brokers, Configuration Interfaces, Analytics) | +| Self-Managed Broker | Broker in a server managed by a user | + diff --git a/content/docs/other/introduction/introduction.md b/content/docs/other/introduction/introduction.md new file mode 100644 index 0000000..d5cf4c7 --- /dev/null +++ b/content/docs/other/introduction/introduction.md @@ -0,0 +1,19 @@ +--- +title: "Introduction" +date: 2023-08-25T23:36:29+01:00 +draft: false +weight: 10 +--- + + + +This tutorial will guide you to start with panduza. + +Panduza is composed of 2 main parts: + +- The platform: it's the software installed into your lab that will dialog with your devices +- The clients: they are the softwares and libraries that will serve you to dialog with the platform + +Currenlty the platform is only compatible with Linux systems and clients are cross-platforms. + +