Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kerogs/bras


https://github.com/kerogs/bras

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README

        


banner

B.R.A.S


Projet BRAS - Code et Documentation.


GitHub commit activity

### Language de programmation
![C++](https://img.shields.io/badge/c%2B%2B-00599C?style=for-the-badge&logo=c%2B%2B&logoColor=fff)
![C](https://img.shields.io/badge/C-%23A8B9CC?style=for-the-badge&logo=C&logoColor=000)
![LabVIEW](https://img.shields.io/badge/labview-%23FFDB00?style=for-the-badge&logo=labview&logoColor=000)

### Documentation
![Vitepress](https://img.shields.io/badge/vitepress-5C73E7.svg?style=for-the-badge&logo=vitepress&logoColor=white)
![VueJS](https://img.shields.io/badge/vue.js-4FC08D.svg?style=for-the-badge&logo=vue.js&logoColor=white)

### Conception
![Proteus](https://img.shields.io/badge/proteus-%231C79B3?style=for-the-badge&logo=proteus&logoColor=fff)
![EasyEDA](https://img.shields.io/badge/easyeda-%231765F6?style=for-the-badge&logo=easyeda&logoColor=fff)

### Marque Composants
![Adafruit](https://img.shields.io/badge/Adafruit-%23000?style=for-the-badge&logo=adafruit&logoColor=fff)
![Motorola](https://img.shields.io/badge/Motorola-%23E1140A?style=for-the-badge&logo=motorola&logoColor=fff)
![STMicroelectronics](https://img.shields.io/badge/stmicroelectronics-%2303234B?style=for-the-badge&logo=stmicroelectronics&logoColor=fff)

### Marque Composant intégré
![DFRobot](https://img.shields.io/badge/DFRobot-%23ed6a00?style=for-the-badge&logoColor=fff)
![img](https://img.shields.io/badge/KS--Components-dd2222.svg?style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADwAAAA8CAYAAAA6/NlyAAAEv0lEQVRoge2aa4hVVRTHf+pYX9S0QpwCIwwrKMiRqUHtRQ96aBQ6YalQGkWEJWUSFVhRENKQRRRCU/agItEPKUXRy57GhDIVg9FDTHvZw+xaDGmtWLEuHC73nLP3uudMl5n5w/5y9lp7rf/eZ6/9WiNE5AXgIoYGNithGSJk/8NIYH8T+DFQ2K+Eh9IIy8gmcGJAMUx4sGOY8GDHMOHBjmHCgx1DkvDYJvBjwNAC7AXGZeypxTpmVAFOHQBGRMjrweZP4KiiOkSPh5OMzD8pMkp4LvBIA3Z6gU6gEkH4D+ugncAnwMvAacCsBjqgoiP8Q4DgDqcBxedAB9Dv0H3N/Ds38W00cAZwBXB1dBzS839AuVJ8+FpEJgTaqC29InIwR+Y4EXk8wrPfy4zS3wLtFiNi8T4wBRiTo/clcA0wA9gWYqMswhUj+4tD91UjcFjENPgQaAMeyBMsg7BG1dOB7x26G4HzgfHA3w79W4HlWQJFE+63ke116G4AZgOtwL4GfOgCrgJ+rldZNGH9Ffscek8DlwFHBK4aeXgK2FRPpkjCZ4cGjhp0A4uAycCvBfmyAphfr6KlIANn6SW3Q083M4uBE4Bdie8dNo/7bXrERPpVNpfro4B1+ELnOrvK9Kckvp0sIttq2t8nIt0iMjWgzbV563CjhBc5yd5r+m2Jby0isjvDWd2EzM9oc1MO2YYJL3SSvcP0Z9Z8bwtwWEw/qacd9VagrpvwYifZW0y/vU7dMYFOK1abzjgR+TRCL5jw5QmlFU6yN5j+BRkyT0Y4f7eI9ETIRxG+zhRuc5JdYvpzAmS7IkmUQniliDzrJLvAjF0codMhIuv/T8JHOsnONkPeaK6BbI2I/FYUYb3xcOwXgjDDjnnbgRMbbGsCMM82KR0NtFMpi/DhiaOhnnpmAh8V1PZ5wPW2945FxfObhZTRNXPwixJs6HTZXtYc9pbvEsbWltC+/qH3NRPhU2oMPl+Snc5mIaxleY3RN0WktQQ7IReNA0JYy3u1hm3HNqpgO7fnES5zWUpivB3uay/h9b77QeBR5x1WPfRlLIOlRel6ZWFGz+8QkTtFZHIBdi5thl+6Wp7I+eUO2nIWsufOKnuKJrxFROY6dXflkK5iqx1aPDbSTl0uwptNebetg7H67YGEq3hbRCZG2liWRjj21vIde8hSHA286AgqPcD9EfJn2uthzIth+uNfYI/pzcLrKb3W6fzt3o0c6cci2p7V6AhfApyTUvcMcGhE7yfbjMHUCNnUN+hQwlmv/0p2XaTz2F3zggj5byJkJ6ZVhBI+kFM/B7gxwqEqngPesOyDV3JkuyLaPTatosinloecqQjVJ5FuezlcD3wF/Gij+hJwKvBZRJvTU2sCg0BoBsBWZwCrnnaS3w5xLnuqs7fRoBWKacBKh946e+1Lvhz+5czWn2d79/ooeISrmOYcacXDTt1q6cvwq7Qcj41OPb37WmrpSR7clHdhWBZh3YWtceh9YFNii0NXL/dW5wmVmcVzrUXXWNwD7In8S6ZbMkwuQgl7dlLYiLU69E6yfI+bA2SXAR8HZviNDc0A0JxHTUWKhSau6o2GZs3FRNyfgCW2NmsET2YHVHE8cFdiHc/3D3r+BcBSA5D+vEfCAAAAAElFTkSuQmCC)

### Marque Equipement
![Stone](https://img.shields.io/badge/stone-blue?style=for-the-badge&logo=stone&logoColor=fff)
![Arduino Mega](https://img.shields.io/badge/Arduino-%2300878F?style=for-the-badge&logo=arduino&logoColor=fff&logoSize=fff)

### Hébergement
![img](https://img.shields.io/badge/KS--Infinite-4e42d4.svg?style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAAA0CAYAAAA62j4JAAAFaUlEQVRogc2bCahWRRTHf+ZuoZVJUlZWlgiKJWpCJWJ7iBbZvmgokaglLShBCEVpJhEGSSJB5dIiGC1ie5hWlpTmizClVSQSwtKe2lP/cV7nyufX+5Y7c+/9/MP94N2Zc2bm3Jkz/zlzXjtJG0mPycCGALly3Ao8WKFsP7C3iuwh4CtgpuvpAXwCfONl9UFhGCWJyOd6SQcD2zdsl3SmpFll73+XtFjSyHr61ygDjJX0T+Tg+0maVqPeJkk3SGp3NBlgdOTgd0oaJGlKCpkvJQ1rqz/HZLCO0+Ai4C2gY6D8LmA0MBh4NoXcUOBzYE5520UaYBjwNtA1UP4v4EpgAPBCgLyNdRbwEdC79GURGASsAroHtrXXB38ysCSy3xcCnwHnFGWAfsC7wEmB8jb4MT5zXotYPqXoC3xqH6ZDBsqqoQ/wcemUS4kW4DrgALAa6JRh3+yDLM/TAL198KcGytvgxwN/+AwK9R2V8CNwTV4G6AW8B5wdKG9MboJ3ck2E76iEJuAKYEcePqCHe/uBgfIC7gCMon8IHF9SZg5wpE/fnsBw4DFgZwr95gAvtsH/11oYKhGhbpLWRpAcOcHp52yvFNOrkKsekp6pQ/cq72MuTLCTpPcD9SUwattH0k9l77fWyTLHSNpVQfdS72MuVLijpDcCdSWY5YPf1kbZyhRUe4CkX8vkF1Q6D2RhgPZu3RjMltRLUlMFHU0pzxu2hHa47Ow8T4Nm1UWRg58rqaekzTXqTUxphKGS7q5VL9YATwfKJ1jgDmx9HXVbJN1T7Wgb8sQY4PFA2QQLJXWRtCalnO0yIxptgFiHt8S/5LIIHaslXdIoA8RgqTvOsRnpM98xSVLXEAMUHRBZ5izvIHBGRjqNcS4GfnFWmOrsYdNQGXWkFqyd/sBWr3ecc/KsDJGgxaNFc4HfalUucga080hOe/97D3B7qhB2fbB4wb3ANuARoEtVqQb4gIfL1uGMnNvbIum8o8kJHpA0vKwj5bH9rNHs54T/GaBIH1AKm57n+zJIcK07sxNzajOJLr1Z+rLoXSCBxQmfKnu30j360pzaNN/wCjDkiLeFL4AjMa7C2rzAiU4e2FLKGRo1AxIsrhAwXe9h8BHACucNWeFcYEaiq1E+oBQW7b3aeUIl9PWtbbLzh1hYCO201hvoBi+BBNPqpK52cnxA0s8ZtGlUPJMlYN71RmBehI4n/cqrFv4E5nu0+U6PGofi8la5SCva/nqpf53Ofh0diq/bitnVeMyZzQtsb10sEWr2q+7STg6WtD9C5xOBx9qpAW1ZyCzYAG0NPnlmBuo0HIrIPfgiZVu7Y7bBu/zSoi3YGl0XqNcOTC+WXYbUiw9S1u9mP6EG2F6l7KCf+f8O1G3b08IAuQMp6++2n7yI0A/AfRHyNwG3pJQZUkedUljCRa5McJEnRYTCghqnA6cAZ9XQYVvaVSnb+d5+8s4PmORRn54BsnbJ+hJwGbAWaAZe9cvN7e4vjA/cDEzxv9PAcoYKyRIbH9hGAttVBkraF6mnHK2h9SIOQyv8WjsUj/pR9qEM+9SUzICiToPTa+wc1dDRYwTPeYZXFjgciyjKAJbfNzFCfoBHeSf4eSAGG923tKLIeIARlQUR8tM8YjQ1Qkezc5TDnKHogIhldm+JkH8eeMdDW2lxyLPKN5fKFW2AfcBtAawtQW+PIk1J6VNafPCvlxc0IiS2wT17KMZ5+tyEGlGkBHZlNgp4uc3SwD00Nl2+Q505AZWwx7NA5teoM0dS9zxuh7P4h4n+fqwOhRnw2DaCMN9Kul/SCfX0w6jwpoCpWHqhEQpzhhboDPXqnT2H2Na2LYfvPKnSLl3qA/AvAbrS2uRVStYAAAAASUVORK5CYII=)

## Installation
1. Effectuer la commande suivante pour cloner le repository
```sh
git clone https://github.com/kerogs/bras.git
```

## Accès à la documentation
Pour simplement ouvrir et consulter la documentation :
1. Rendez vous sur le site de la documentation [ks-infinite.fr](https://bras.ks-infinite.fr/)
- Ou alors Passer à l'étape ***Modification et lancement de la documentation*** pour la version self hosted

## Modification et lancement de la documentation
Pour lancer la documentation en local et effectuer des modifications :

1. Installez ``NodeJS`` via [ce lien](https://nodejs.org/en/download/current)
2. Clone le repository
```sh
git clone https://github.com/kerogs/bras.git
```

2. Accédez au dossier ``/docs/``
```sh
cd docs
```

3. Installer les packages
```sh
npm install
```

4. Exécutez la commande suivante pour lancer la documentation en local :
```sh
npm run docs:dev
```

Une fois le chargement terminé, une adresse IP locale avec son port sera affichée. Ouvrez cette adresse dans un navigateur web pour accéder à la documentation.

Tous les fichiers de documentation sont rédigés au format Markdown, mais fonctionnent sous VitePress. Vous pouvez donc vous renseigner sur la personnalisation de VitePress.

## Code arduino
Tout le code Arduino est situé dans le dossier ``/public/code/``. Le code principal se trouve dans ``/public/code/main.ino``. Il existe une partie qui s'appelle ``admin.ino`` qui sert à tester l'intégralité du code. La documentation des commandes est disponible dans la section ADR dans la version du code admin choisis.

### Modifications
***Voici la liste des éléments à ajouter :***

- Intégrer votre nouvelle version de code dans le dossier ADR et la lier à son fichier ``/docs/ADR/index.md``.
- Toute ajout de fonction, variable ou dépendance.

Avant d'apporter des modifications, veuillez mettre à jour la documentation. Si vous souhaitez générer la documentation au format HTML et la placer dans ``/public/docs/`` exécutez la commande suivante :

```bash
npm run docs:build
```

Si vous modifiez la sortie de la documentation, pensez également à modifier le chemin d'accès dans le fichier ``/docs/.vitepress/config.mts``
```ts
export default {
outDir: '../public/docs'
}
```

Si vous modifiez la sortie de la documentation, pensez également à modifier le chemin d'accès dans le fichier ``/docs/.vitepress/config.mts``
```ts
export default {
base: '/public/docs/',
}
```

## Utilisation de la documentation.
Le code embarque avec lui une version selfhosted de la documentation. Pour cela, il vous suffit d'effectuer les commandes suivantes :
- Accédez au dossier ``/docs/``
```sh
cd docs
```

- Exécutez la commande suivante pour build la documentation :
```sh
npm run docs:build
```
- Ou le faire en 1 commande
```sh
cd .\docs\; npm run docs:build
```
- Il vous suffit donc maintenant d'héberger en local les fichiers HTML (important pour le chargement du CSS)

## Schéma + Shield
![Schéma](./public/proteus/preview2.png)
![Shield](./public/proteus/preview1.png)

## License
Licence Apache 2.0 (voir le fichier LICENSE)

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)