Skip to content

Commit

Permalink
add more doc
Browse files Browse the repository at this point in the history
  • Loading branch information
raoulh committed Mar 7, 2024
1 parent 9bf674a commit 3e2c875
Show file tree
Hide file tree
Showing 49 changed files with 286 additions and 19 deletions.
8 changes: 5 additions & 3 deletions content/getting_started/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ weight = 5
chapter = true
+++

### Getting Started with Calaos
### Getting Started

# Some Chapter title
# Getting Started with Calaos

Lorem Ipsum.
Learn how to quickly install and configure Calaos.

![Calaos Home](/en/getting_started/images/pic_kitchen.jpg?width=50pc)
34 changes: 34 additions & 0 deletions content/getting_started/create_io.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,37 @@ title = 'Create an IO'
date = 2024-03-06T19:49:13Z
weight = 30
+++

## I/O in Calaos

In this step, we will introduce our first inputs/outputs (IO) in Calaos Installer. In Calaos, an IO represents various elements such as a lamp, a switch, a blind, etc. To do this, we use a hierarchy based on rooms to which we add I/O. You can start by creating a room in Calaos Installer. The type of room you choose will affect its icon in the interfaces.

## Creating a Room

To create a room, start by clicking on **Add** in the menu, then select **Room**. Next, enter the name of the room you want to create and choose the corresponding type from the available options.

![room menu](/en/getting_started/images/calaos_installer_room_menu.png?width=20pc&classes=shadow)
![new room](/en/getting_started/images/calaos_installer_new_room.png?width=20pc&classes=shadow)

## Creating a Light

To add a light, start by clicking on **Add** in the menu, then choose **Wago PLC** followed by **Light**. Next, give the light a name and specify the output address on the PLC. Once done, press **OK**. The light will be added to the selected room.

![new light](/en/getting_started/images/menu_light.png?width=20pc&classes=shadow)
![new light](/en/getting_started/images/wago_light.png?width=20pc&classes=shadow)

{{% notice note %}}
Keep in mind that this example is based on using a Wago PLC, but you can also apply the same procedure for other types of light fixtures if needed.
{{% /notice %}}

## Creating a Switch

To add a switch, navigate to the Add option in the menu, then select Wago PLC followed by Switch. Next, assign a name to your switch and specify the appropriate output address on the PLC. Once these steps are completed, confirm by clicking OK.

{{% notice note %}}
Just like adding a light, remember that this example is specific to a Wago PLC, but the process remains the same for other types of switches if needed.
{{% /notice %}}

![rule](/en/getting_started/images/io.png?width=20pc&classes=shadow)

Once you have added your inputs/outputs, you can proceed to the next step: [Creating Rules]({{%relref "getting_started/create_rule" %}}).
34 changes: 34 additions & 0 deletions content/getting_started/create_io.fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,37 @@ title = 'Créer une IO'
date = 2024-03-06T19:48:49Z
weight = 30
+++

## Les IO dans Calaos

Dans cette étape, nous allons introduire nos premières entrées/sorties (I/O) dans Calaos Installer. Dans Calaos, une I/O représente divers éléments tels qu'une lampe, un interrupteur, un volet, etc. Pour ce faire, nous utilisons une hiérarchie basée sur des pièces auxquelles nous ajoutons des I/O. Vous pouvez commencer en créant une pièce dans Calaos Installer. Le type de pièce que vous choisissez affectera son icône dans les interfaces.

## Créer une pièce

Pour créer une pièce, commencez par cliquer sur **Ajouter** dans le menu, puis sélectionnez **Pièce**. Ensuite, saisissez le nom de la pièce que vous souhaitez créer et choisissez le type correspondant parmi les options disponibles.

![room menu](/en/getting_started/images/calaos_installer_room_menu.png?width=20pc&classes=shadow)
![new room](/en/getting_started/images/calaos_installer_new_room.png?width=20pc&classes=shadow)

## Créer une lumière

Pour ajouter une lumière, commencez par cliquer sur **Ajouter** dans le menu, puis choisissez **Wago PLC** suivi de **Lumière**. Ensuite, donnez un nom à la lumière et spécifiez l'adresse de sortie sur l'automate. Une fois terminé, appuyez sur **OK**. La lumière sera ajoutée à la pièce sélectionnée.

![new light](/en/getting_started/images/menu_light.png?width=20pc&classes=shadow)
![new light](/en/getting_started/images/wago_light.png?width=20pc&classes=shadow)

{{% notice note %}}
Gardez à l'esprit que cet exemple est basé sur l'utilisation d'un automate Wago, mais vous pouvez également appliquer la même procédure pour d'autres types de luminaires si nécessaire.
{{% /notice %}}

## Créer un interrupteur

Pour ajouter un interrupteur, dirigez-vous vers l'option **Ajouter** dans le menu, puis sélectionnez **Wago PLC** suivi de **Interrupteur**. Ensuite, attribuez un nom à votre interrupteur et indiquez l'adresse de sortie appropriée sur l'automate. Une fois ces étapes terminées, validez en cliquant sur **OK**.

{{% notice note %}}
Tout comme pour l'ajout d'une lumière, rappelez-vous que cet exemple est spécifique à un automate Wago, mais le processus reste le même pour d'autres types d'interrupteurs si nécessaire.
{{% /notice %}}

![rule](/en/getting_started/images/io.png?width=20pc&classes=shadow)

Une fois que vous avez ajouté vos entrées/sorties, vous pouvez passer à l'étape suivante: [la création de règles]({{%relref "getting_started/create_rule" %}}).
16 changes: 16 additions & 0 deletions content/getting_started/create_rule.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,19 @@ title = 'Create a rule'
date = 2024-03-06T19:49:17Z
weight = 40
+++

## Rules in Calaos

In Calaos, the operation is based on rules. A rule consists of one or more conditions that must be met (i.e., be true) in order to execute a list of actions.

## Creating our First Rule

To create a rule, click on the **+** button located above the list of rules. You will then need to give a name and a type to categorize this rule. Next, use the drag-and-drop function to place the switch in the conditions section of the rule, and do the same with the light in the actions section.

![rule](/en/getting_started/images/add_rule.png?width=20pc&classes=shadow)

In this example, this rule will turn the light on or off as soon as you press the switch. This works like a two-way switch, where the switch controls the state of the light.

![rule](/en/getting_started/images/simple_rule.png?width=20pc&classes=shadow)

Now that you have configured your rules and devices, it's time to send this configuration to the server. [Next Chapter]({{% relref "getting_started/upload" %}})
16 changes: 16 additions & 0 deletions content/getting_started/create_rule.fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,19 @@ title = 'Créer une règle'
date = 2024-03-06T19:48:52Z
weight = 40
+++

## Les règles dans Calaos

Dans Calaos, le fonctionnement est basé sur des règles. Une règle consiste en une ou plusieurs conditions qui doivent être vérifiées (c'est-à-dire être vraies) pour pouvoir exécuter une liste d'actions.

## Créer notre première règle

Pour créer une règle, cliquez sur le bouton **+** situé au-dessus de la liste des règles. Vous devrez alors donner un nom et un type pour catégoriser cette règle. Ensuite, utilisez la fonction de glisser-déposer pour placer l'interrupteur dans la section des conditions de la règle, puis faites de même avec la lumière dans la section des actions.

![rule](/en/getting_started/images/add_rule.png?width=20pc&classes=shadow)

Dans cet exemple, cette règle permettra d'allumer ou d'éteindre la lumière dès que vous appuierez sur l'interrupteur. Cela fonctionne comme un télérupteur, où l'interrupteur contrôle l'état de la lumière.

![rule](/en/getting_started/images/simple_rule.png?width=20pc&classes=shadow)

Maintenant que vous avez configuré vos règles et vos dispositifs, il est temps d'envoyer cette configuration vers le serveur. [Chapitre suivant]({{% relref "getting_started/upload" %}})
Binary file added content/getting_started/images/add_rule.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/getting_started/images/ban1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/getting_started/images/io.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/getting_started/images/menu_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/getting_started/images/menu_switch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/getting_started/images/simple_rule.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/getting_started/images/upload.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/getting_started/images/wago_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/getting_started/images/wago_switch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions content/getting_started/installation.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,29 @@ title = 'Installation'
date = 2024-02-03T16:26:37Z
weight = 20
+++

## Calaos Image Creator

Calaos Installer provides a tool to download and create an image on a bootable USB key. From Calaos Installer, in the **Project Management** menu, select **Create an Image**.

![Create Image menu](/en/getting_started/images/calaos_installer_creator_menu.png?width=20pc&classes=shadow)
![Create Image](/en/getting_started/images/calaos_installer_creator.png?width=20pc&classes=shadow)

Choose the latest stable version of Calaos OS from the dropdown list, then click **Continue**. The image is then downloaded from the Calaos server. This operation may take a few minutes and depends on the speed of your internet connection. Once the download is complete, insert a USB key into your computer. It will be formatted, and the image files will be copied onto it. The USB key should appear in the application window. Select the USB key and click **Continue**.

## First Boot

Once the image is copied to the USB key, you can insert it into the PC that will serve as the Calaos server. Restart the machine and boot from the USB key.

When Calaos OS starts, you have two options:

- Use Calaos OS in Live mode to test the system without installing it.
- Directly install Calaos OS on the internal disk of the machine.

{{% notice info %}}
The **Live** mode allows you to configure the system, test the features, and check if everything is working correctly. If you are satisfied, you can then install Calaos OS on the internal disk of the server. You will keep all the configurations you made in Live mode. See more details on the [dedicated page].
{{% /notice %}}

When the **Live** mode has started, the graphical interface of Calaos OS appears on the screen. You can then configure your system, add I/Os, rules, and scenarios. For now, the interface is empty, but we will see how to configure it in the next step.

[Next Chapter]({{% relref "getting_started/create_io" %}})
27 changes: 18 additions & 9 deletions content/getting_started/installation.fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,28 @@ date = 2024-02-03T16:26:42Z
weight = 20
+++

A partir de Calaos Installer, dans le menu **Gestion du projet** sélectionnez **Créez une image**.
## Calaos Image Creator

![Create Image](/en/getting_started/images/calaos_installer_creator.png?width=20pc)
Calaos Installer fournit un outil pour télécharger et créer une image sur une clé USB amorçable. A partir de Calaos Installer, dans le menu **Gestion du projet** sélectionnez **Créez une image**.

Choisir la dernier version stable de Calaos OS dans la liste déroulante, puis cliquer sur "Continuer". L'image est alors téléchargée depuis le serveur de Calaos. Cette opération peut prendre quelques minutes et depends de la vitesse de votre connexion internet. Une fois le téléchargement terminé, insérer une clef USB dans votre ordinateur. Celle-ci sera formatée et les fichiers de l'image seront copiés dessus. La clé USB devrait apparraitre dans la fenêtre de l'application. Choisir la clé USB puis cliquer sur "Continue".
![Create Image menu](/en/getting_started/images/calaos_installer_creator_menu.png?width=20pc&classes=shadow)
![Create Image](/en/getting_started/images/calaos_installer_creator.png?width=20pc&classes=shadow)

Une fois l'image copiée sur la clé USB, vous pouvez l'insérer dans le PC qui servira de serveur Calaos. Redémarrer le PC et booter sur la clé USB. L'installation de Calaos OS démarre alors.
Choisir la dernier version stable de Calaos OS dans la liste déroulante, puis cliquer sur **Continuer**. L'image est alors téléchargée depuis le serveur de Calaos. Cette opération peut prendre quelques minutes et depends de la vitesse de votre connexion internet. Une fois le téléchargement terminé, insérer une clef USB dans votre ordinateur. Celle-ci sera formatée et les fichiers de l'image seront copiés dessus. La clé USB devrait apparraitre dans la fenêtre de l'application. Choisir la clé USB puis cliquer sur **Continuer**.

Lorsque Calaos OS demarre vous avez deux possibilités:
## Premier démarrage

- Utiliser Calaos OS en mode "Live" pour tester le système sans l'installer
- Installer Calaos OS sur le disque dur de votre PC
Une fois l'image copiée sur la clé USB, vous pouvez l'insérer dans le PC qui servira de serveur Calaos. Redémarrer la machine et démarrer sur la clé USB.

Le mode "Live" vous permettre de configurer votre systeme, de tester les fonctionnalités et de voir si tout fonctionne correctement. Si vous êtes satisfait, vous pouvez alors installer Calaos OS sur le disque dur du serveur. Vous garderez alors toutes les configurations que vous avez faites en mode "Live".
Lorsque Calaos OS démarre vous avez le choix entre deux possibilités:

Lorsque le le mode "Live" a demarré, L'interface graphique de Calaos OS apparait sur l'écran. Vous pouvez alors configurer votre systeme, ajouter des I/O, des règles, des scénarios. Pour le moment l'interface est vide, mais nous allons voir comment la configurer.
- Utiliser Calaos OS en mode **Live** pour tester le système sans l'installer
- Installer directement Calaos OS sur le disque interne de la machine

{{% notice info %}}
Le mode **Live** permet de configurer le systeme, de tester les fonctionnalités et de voir si tout fonctionne correctement. Si vous êtes satisfait, vous pouvez alors installer Calaos OS sur le disque interne du serveur. Vous garderez alors toutes les configurations que vous avez faites en mode **Live**. Voir plus de détails sur la [page dédié]({{%relref "calaos_os/installation" %}})
{{% /notice %}}

Lorsque le le mode **Live** a demarré, l'interface graphique de Calaos OS apparait sur l'écran. Vous pouvez alors configurer votre systeme, ajouter des I/O, des règles, des scénarios. Pour le moment l'interface est vide, mais nous allons voir comment la configurer dans la prochaine étape.

[Chapitre suivant]({{% relref "getting_started/create_io" %}})
18 changes: 18 additions & 0 deletions content/getting_started/requirements.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,21 @@ title = 'Requirements'
date = 2024-02-03T16:25:45Z
weight = 10
+++

## Prerequisites

To install Calaos, you will need:

- An Intel-based PC to serve as the Calaos server
- With a hard drive capacity of at least 16GB
- And 1GB of RAM
- A monitor, keyboard, and mouse
- A USB key of at least 4GB for installation

To begin, download Calaos Installer from this address: {{% button href="https://www.calaos.fr/download/stable/calaos_installer/" icon="fas fa-download" %}}Download Calaos Installer{{% /button %}}

This installer is compatible with Windows, Mac, and Linux operating systems. Once downloaded, launch the application.

[Next Chapter]({{% relref "getting_started/installation" %}})

![Calaos Installer GUI](/en/getting_started/images/calaos_installer_empty.png?width=50pc)
4 changes: 3 additions & 1 deletion content/getting_started/requirements.fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@ Pour installer Calaos, vous aurez besoin de:
- Un écran, clavier et souris
- Une clef USB de 4GB minimum pour l'installation

Pour commencer, téléchargez Calaos Installer a cette addresse: [Télécharger Calaos Installer](https://www.calaos.fr/download/stable/calaos_installer/).
Pour commencer, téléchargez Calaos Installer a cette addresse: {{% button href="https://www.calaos.fr/download/stable/calaos_installer/" icon="fas fa-download" %}}Téléchargez Calaos Installer{{% /button %}}

Ce dernier est compatible avec les systèmes d'exploitation Windows, Mac et Linux. Une fois téléchargée, lancer l'application.

[Chapitre suivant]({{% relref "getting_started/installation" %}})

![Calaos Installer GUI](/en/getting_started/images/calaos_installer_empty.png?width=50pc)
20 changes: 20 additions & 0 deletions content/getting_started/test.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,23 @@ title = 'Test'
date = 2024-03-06T19:49:09Z
weight = 50
+++

## Turning on the Light

Now, you have the ability to turn on the light in different ways: first, through the switch, thanks to the rule we created earlier. Additionally, you can also directly control the light in one of the many Calaos interfaces. By directly controlling an IO, its state will be modified, and Calaos will manage it automatically.

It is important to note that not all types of IO are displayed or controllable in all user interfaces. Calaos offers several types of interfaces, including Calaos Home designed for touch screens, Calaos Mobile which is a mobile application available on Android and iOS, as well as Calaos WebApp, a web interface accessible via the IP address of your Calaos server at `https://<Calaos IP address>`

## Further Exploration

Now that you have started using Calaos, you can delve deeper by consulting our documentation. There you will find detailed information on various topics:

- [Supported Hardware]({{% relref "hardware" %}}): Discover which devices are compatible with Calaos and how to integrate them into your home automation system.

- [Calaos Installer]({{% relref "calaos_installer" %}}): Deepen your knowledge on creating and managing rules. Learn how to automate different actions to make your environment smarter and more responsive.

- [Calaos-OS]({{% relref "calaos_os" %}}): Explore our Calaos-OS operating system. Learn how to install, configure, and make the most out of its features for an optimal home automation experience.

Our documentation is designed to provide you with all the necessary information to fully leverage Calaos and customize your system according to your specific needs. Feel free to explore it to discover everything you can do with Calaos.

![Calaos Home](/en/getting_started/images/ban1.png)
20 changes: 20 additions & 0 deletions content/getting_started/test.fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,23 @@ title = 'Tester'
date = 2024-03-06T19:49:06Z
weight = 60
+++

## Allumer la lumière

Maintenant, vous avez la possibilité d'allumer la lumière de différentes manières: tout d'abord, à travers l'interrupteur, grâce à la règle que nous avons créée auparavant. De plus, vous pouvez également contrôler directement la lumière dans l'une des nombreuses interfaces de Calaos. En pilotant directement une IO, son état sera modifié et Calaos le gérera automatiquement.

Il est important de noter que tous les types d'IO ne sont pas affichés ou contrôlables dans toutes les interfaces utilisateur. Calaos propose plusieurs types d'interfaces, notamment Calaos Home conçu pour les écrans tactiles, Calaos Mobile qui est une application mobile disponible sur Android et iOS, ainsi que Calaos WebApp, une interface web accessible via l'adresse IP de votre serveur Calaos à l'adresse `https://<adresse IP de Calaos>`

## Approfondir

Maintenant que vous avez commencé à utiliser Calaos, vous pouvez explorer davantage en consultant notre documentation. Vous y trouverez des informations détaillées sur divers sujets :

- [Matériel pris en charge]({{% relref "hardware" %}}) : Découvrez quels équipements sont compatibles avec Calaos et comment les intégrer dans votre système domotique.

- [Calaos Installer]({{% relref "calaos_installer" %}}): Approfondissez vos connaissances sur la création et la gestion des règles. Apprenez comment automatiser différentes actions pour rendre votre environnement plus intelligent et réactif.

- [Calaos-OS]({{% relref "calaos_os" %}}) : Explorez notre système d'exploitation Calaos-OS. Apprenez à l'installer, à le configurer et à en exploiter toutes les fonctionnalités pour une expérience domotique optimale.

Notre documentation est conçue pour vous fournir toutes les informations nécessaires pour tirer pleinement parti de Calaos et personnaliser votre système selon vos besoins spécifiques. N'hésitez pas à l'explorer pour découvrir tout ce que vous pouvez faire avec Calaos.

![Calaos Home](/en/getting_started/images/ban1.png)
Loading

0 comments on commit 3e2c875

Please sign in to comment.