mydil - Contributions [fr]

Iot speaker

2019-07-23T16:50:14Z

Tala : /* Installation */

=Projet=
{|class="wikitable" width="100%"
|-valign=top
! Objectif !! Les acteurs !! Compétences !! Matériel
|-valign=top
||
Construire des enceintes sans-fils (sauf le courant) actives connectées capables de travailler en "groupe"
||
*[[User:Tala | Tala]]
*[[User:Nigdor |Nigdor]]
*[[User:Prandar |Prandar]]
||
*électronique
*C++ (microcontrôleur)
||
* microcontrôleur (esp8266)
* amplificateur audio (XPT8871, PAM8403, ...)
* décodeur MP3 (VS1053B)
* potentiomètre digital (X9C103S)
|}

= Choix de l'amplificateur =
A faire:
*Expliquer la différence entre classe AB et D (qualité sonore vs. éco énergie)
*Faire un tableau récapitulatif des caractéristiques des amplis:
** mono / stéréo / les deux
** tension de fonctionnement / consommation (5v, 12v, 24v, etc...)
** puissance (5w, 20w, 30w, etc...)
** impédance de sortie (2 x 4Ω, 1 x 8Ω, etc...)
** réponse fréquentielle ;
** résistance aux courts-circuits ;
** bruit pop (quand pas de musique);
** besoin d'un dissipateur ou non (effet joule à prévoir...)
** lien vers la documentation si besoin d'info(eg. pour le [https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932])
** le plus important : le ressenti !
==Classe AB==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
TDA7297
|align=center|
[[Fichier:TDA7297.png|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 15W
|align=center|
2A (peak)
|align=center|
6 - 18 V
|align=center|
OUI
|align=center|
Avec µControlleur<br>(p. 3/4)
|align=center|
Obligatoire
|align=center|
[http://www.st.com/content/ccc/resource/technical/document/datasheet/a3/eb/9b/59/dd/26/4a/27/CD00001048.pdf/files/CD00001048.pdf/jcr:content/translations/en.CD00001048.pdf TDA7297]
|align=left|
Super amplification sans distorsion !
<br>
Forte dissipation thermique à pleine puissance :
* 33W d'après la doc;
* vraiment très (trop) fort !
|}
</div>

==Classe D==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
XH-M531 (YDA138)
|align=center|
[[Fichier:XH-M531.jpg|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 10 W<br>
2 x 20 W
|align=center|
8 Ω<br>
4 Ω
|align=center|
12 - 15V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.ksp-electronics.com/product_files/8eeedc66ea8fbcdf2e74294037c2f389 YDA138]
|align=center|
|-valign="top"
|align=center|
PAM8403
|align=center|
[[Fichier:PAM8403.jpg|centré|100px]]
|align=center|
Stéréo
|align=center|
3W(*2 ?)
|align=center|
4 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
Reduit mais présent
|align=center|
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8403.pdf PAM8403]
|align=center|
|-valign="top"
|align=center|
PAM8610
|align=center|
[[Fichier:PAM8610.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 10 W
|align=center|
8 Ω
|align=center|
7 - 15 V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8610.pdf PAM8610]
|align=center|
|-valign="top"
|align=center|
XPT8871
|align=center|
[[Fichier:XPT8871.jpg|centré|120px]]
|align=center|
Mono
|align=center|
3.5w
<br>
5w
|align=center|
3 Ω
<br>
2 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[[Media:XPT8871.pdf|XPT8871]]
|align=left|
*Bien pour la voix, pas top pour la musique
|-valign="top"
|align=center|
TDA8932
|align=center|
[[Fichier:TDA8932.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2*15W
|align=center|
4 Ω
|align=center|
Entre 10 V et 36 V (Rechercher quel est le plus optimal)
|align=center|
OUI
|align=center|
NON
|align=center|

|align=center|
[https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932]
|align=center|
|-valign="top"
|align=center|
TPA3110
|align=center|
[[Fichier:TPA3110.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
15W/ch
|align=center|
8 Ω
|align=center|
16 V
|align=center|
OUI
|align=center|
NON
|align=center|
OUI
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3110d2.pdf TPA3110]
|align=left|
*Amplification moyenne
*Basses creuses
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3116
|align=center|
[[Fichier:TPA3116.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 50W<br>
2 x 15W
|align=center|
4 Ω<br>
8 Ω
|align=center|
21 V<br>
15 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI<br>
NON
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3116d2.pdf TPA3116]
|align=left|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3118
|align=center|
[[Fichier:TPA3118.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 30W
|align=center|
8 Ω
|align=center|
12 - 24 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI
|align=left|
[http://www.ti.com/lit/ds/symlink/tpa3118d2.pdf TPA3118]
|align=center|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|}
</div>

= Potentiomètre digital =
A faire

= Décodeur MP3 =
==Présentation==
Le décodeur MP3 choisi est le VS1053

[[Fichier:vs1053_board.jpg|centré|200px]]

Ce décodeur offre une interface SPI et permet de lire ainsi que d'enregistrer des fichiers aux formats :
* lecture :
**MP3 ;
**Ogg Vorbis (libre de droit) ;
**PCM;
**WAV;
* enregistrement :
**Ogg Vorbis(libre de droit) ;

==Documentation technique==
Voici la [[:Media:vs1053_doc.pdf|documentation du VS1053]], pour ceux qui voudraient écrire une librairie C++ !

== Schéma ==
Les tests ont été réalisés avec un WemOS D1 mini (ESP8266) :
<div align="center">
{|class="wikitable" width="85%"
! ESP8266 !! VS1053 !! Connections
|-valign=top
||
[[Fichier:wemos_D1_R2_mini_diagram.png|centré|470px]]
||
[[Fichier:vs1053_board_diagram.png|centré|300px]]
|align="center"|
{|class="wikitable"
! ESP8266 !! VS1053
|-
|align="center"| D0
|align="center"| XDCS
|-
|align="center"| D1
|align="center"| XoS (Cable Select)
|-
|align="center"| D3
|align="center"| DREQ
|-
|align="center"| D5
|align="center"| SCK (Serial ClocK)
|-
|align="center"| D6
|align="center"| MISO (Master In Slave Out)
|-
|align="center"| D7
|align="center"| MOSI (Master Out Slave In)
|-
|align="center"| RST
|align="center"| XRST
|-
|align="center"| 5V
|align="center"| 5V
|-
|align="center"| G
|align="center"| DGND
|}
|}
</div>
Vous devriez avoir quelque chose comme ça :

[[Fichier:wemos_D1_vs1053_diagram.jpg|centré|400px]]

== Programmation ==
Tout d'abord un grand merci à [https://github.com/baldram/ESP_VS1053_Library ''baldram''] pour sa [[Media:ESP_VS1053_Library.zip|librairie]] que nous allons utiliser !

Le plus simple est de regarder l'exemple ''SimpleMP3Player'' fourni avec la librairie :
<source lang="c">
// La fameuse librairie de baldram
#include <VS1053.h>
// Un MP3 au format binaire dans un tableau (le fichier est livré avec la librairie)
#include <helloMp3.h>
// Définition des port SPI utilisé (ici pour l'ESP8266)
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
// Définition du volume
#define VOLUME 80 // volume level 0-100
// Création de l'objet VS1053
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);

void setup () {
// Démarrage du SPI
SPI.begin();
// démarrage du VS1053
player.begin();
// Ligne nécessaire pour certain lecteur
player.switchToMp3Mode();
player.setVolume(VOLUME);
}

void loop() {
// On joue le MP3 dans le tableau
player.playChunk(helloMp3, sizeof(helloMp3));
// On attend 3 secondes
delay(3000);
}
</source>
Pour que cet exemple fonctionne, il faut soit copier le contenu de ''HelloMp3.h'' dans le fichier exemple, soit copier le fichier dans le répertoire de la librairie dans votre dossier ''Arduino''.

Une fois la compilation terminée, vous devriez entendre ''du bruit'' sortir du VS1053 !

= Flux musical =
La communication se fera en générant un flux entre le programme (PC) et l'enceinte (ESP8266). Ce flux, pour des raisons de simplicité, se fera en TCP car ce protocole gère les retransmissions, les tampons d'entrée / sortie, etc...

A terme, une application temps réel comme la musique mériterait de passer sur de l'UDP. Surtout que, si l'on souhaite utiliser du [https://www.tala-informatique.fr/wiki/index.php/Esp8266_udp_server multicast], pour parler à un groupe d'enceintes, on ne peut le faire qu'en UDP !
== Envoi : serveur en PHP ==
La partie serveur prend un fichier, ici un MP3, lit un morceau du fichier et l'envoi à l'enceinte à travers une socket TCP. Deux paramètres sont à prendre en compte :
*le temps d'attente entre chaque envoi;
*la taille d'un morceau;
Ces paramètres nécessiteront certainement un temps d'ajustement qui sera en fonction de la latence, la congestion du réseau, les capacités des puces impliquées (ici l'ESP8266), etc...
{|style="width:650px" align="center"
|
[[Fichier:warning-icon.png|centré|60px]]
|valign="top" align="justify"|
Les extraits de code qui vont suivre respectent vaguement les préceptes, au combien importants, de la programmation orientée objet et sont fournis à titre indicatif dans l'unique but de démontrer la faisabilité d'un tel projet ! Voici [[:Media:Iot_Speaker.zip | l'archive]] qui contient le code exposé ci-dessous.
|}
=== MusicSender ===
Voici le contenu du fichier ''MusicSender.class.php'' :
<source lang="php">
<?php

class MusicSender
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5045;

// Le temps d'attente en microsecondes entre chaque paquets
private static $SLEEP_INTERVAL = 2500;

// La taille de chacun des paquets
private static $CHUNK_BUFFER = 32768;

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Envoie le MP3 à l'enceinte
*
* @param string $mp3File
* @return boolean
*/
public function play($mp3File)
{
if (is_file($mp3File)) {
// Ouverture du fichier en lecture binaire
$file = fopen($mp3File, 'rb');
if ($file === FALSE) {
echo "Fail reading file " . $file . "\n";
return FALSE;
}
// Ouverture de la socket
$socket = $this->openSocket();
// Tant qu'on est pas à la fin du fichier
while (! feof($file)) {
// Envoie d'un "morceau" de taille CHUNK_BUFFER à l'enceinte
if (@socket_write($this->socket, fread($file, self::$CHUNK_BUFFER), self::$CHUNK_BUFFER) === FALSE) {
// Problème de socket (fermeture, déconnexion, etc...)
return FALSE;
}
usleep(self::$SLEEP_INTERVAL);
}
// Fermeture de la socket
$this->closeSocket();
// Fermeture du fichier
fclose($file);
return TRUE;
}
echo $file." does not exists !\n";
return FALSE;
}

/**
* Lit tous les mp3 présents dans le dossier
*
* @param string $dir
*/
public function readFolder($dir)
{
if (is_dir($dir)) {
// On récupére les fichiers sans les 2 premiers '.' et '..'
$files = array_slice(scandir($dir), 2);
foreach ($files as $file) {
// On créé le chemin absolu
$mp3File = $dir . DIRECTORY_SEPARATOR . $file;
// On test l'extension
if (pathinfo($file)["extension"] == "mp3") {
$this->play($mp3File);
}
}
return true;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) == FALSE) {
echo "socket_create_listen() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
if (socket_connect($this->socket, $this->ip, self::$PORT) == FALSE) {
echo "socket_bind() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
=== Launch.php ===
On créé un fichier ''Launch.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicSender.class.php';

$esp_ip = "192.168.1.200";

$dir = "!!chemin_vers_des_fichiers_mp3!!";

$sender = new MusicSender($esp_ip);

$sender->readFolder($dir);
</source>

== Réception : ESP8266 ==
{|style="width:650px" align="center"
|
[[Fichier:Warning manual.jpg|centré|300px]]
|valign="top" align="justify"|
Soyez sûr de comprendre la section sur [https://www.tala-informatique.fr/wiki/index.php/Arduino_sketch_writing| comment écrire un sketch] avant de poursuivre. Le code ci-dessous fait référence à des parties bien spécifiques, détaillées et expliquées dans la section suscitée.
|}
=== Partie WiFi ===
La première étape consiste à raccorder notre ''ESP'' au réseau WiFi !
<source lang="c">
#include <ESP8266WiFi.h>
#include <WiFiClient.h>

// WiFi Parameters //
const char ssid[] = "cfcasa";
const char password[] = "***********";
IPAddress ip(192, 168, 1, 200);
IPAddress gw(192, 168, 1, 254);
IPAddress mask(255, 255, 252, 0);

void setup() {
// on démarre le port série
Serial.begin(115200);
// On attend "un peu" que le buffer soit prêt
delay(10);
// On démarre le WiFi
initWiFi();
}

void loop() {
}

void initWiFi() {
// On efface la configuration précédente
WiFi.disconnect(true);
Serial.printf("\nConnexion a %s", ssid);
// Initialisation de la connection
WiFi.config(ip, gw, mask, gw);
WiFi.begin(ssid, password);
// Test pour déterminer quand la connection est prete
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(".");
}
// Affichage des informations
Serial.printf(" connecté\nAdresse IP: %s\n", WiFi.localIP().toString().c_str());
}
</source>
=== Lecteur MP3 ===
Vient ensuite la partie du lecteur MP3. Dans la partie des imports, ajoutez la ligne suivante :
<source lang="c">
#include <VS1053.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Parameters //
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
#define VOLUME 70 // volume level 0-100
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);
uint8_t volume_level = VOLUME;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le shield MP3
initMP3();
</source>
A la suite, on insère la fonction suivante :
<source lang="c">
void initMP3() {
SPI.begin();
// Démarrage du lecteur MP3
player.begin();
player.switchToMp3Mode();
player.setVolume(volume_level);
}
</source>
=== Récupération du stream MP3 ===
On va maintenant récupérer le flux envoyé depuis le serveur. Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Server parameters //
const uint16_t MP3_PORT = 5045;
WiFiServer server(MP3_PORT);
const uint16_t BUFFER_SIZE = 16384;
//const uint16_t BUFFER_SIZE = 32768;
byte buffer[BUFFER_SIZE + 1];
uint16_t byteRead = 0;
bool isBufferReady = false;
WiFiClient client;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur TCP
initMp3Server();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
void initMp3Server() {
// Démarrage du serveur TCP
server.begin();
Serial.printf("Ecoute TCP sur le port %d\n", MP3_PORT);
}

void readMp3() {
// Un client est connecté
if (client) {
// Si le client est toujours connecté...
if (client.connected()) {
// Tant que l'on reçoit de la musique
while (client.available() > 0) {
// On rempli le buffer avec le contenu du paquet TCP
buffer[byteRead++] = client.read();
// Si le buffer est plein
if (byteRead == BUFFER_SIZE) {
// On previent que le buffer est plein
isBufferReady = true;
// On sort de la boucle
break;
}
}
// Si le buffer est plein
if (isBufferReady) {
// On envoi tout au lecteur MP3
player.playChunk(buffer, byteRead);
// On RAZ le compteur de bytes
byteRead = 0;
}
} else {
// Si le client est déconneté
client = server.available();
// On prévient que le buffer est vide
isBufferReady = false;
// On RAZ le compteur de bytes
byteRead = 0;
Serial.println(F("Client disconnected"));
}
} else {
// On test la présence d'un client
client = server.available();
if (client) {
// Un client est connecté !
Serial.println(F("New client !"));
}
}
}
</source>
Enfin, on ajoute le ligne suivante dans la fonction ''loop()'' :
<source lang="c">
readMp3();
</source>
A ce stade, l'ESP devrait être capable de récupérer le flux et de le jouer !

= Envoi de commandes =
Envoyer de la musique c'est bien, pouvoir régler le volume c'est encore mieux !

La façon la plus simple d'adresser le problème c'est d'utiliser un autre port et, comme les messages sont petits, d'utiliser UDP.
== Partie Serveur ==
Dans la même veine, voici la classe qui permet d'envoyer les commandes :
<source lang="php">
<?php

class MusicHandler
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5046;

// Le port de l'enceinte connectée
private static $RETRIES = 3;

// Liste de commandes
private static $CMD_VOLUME = 'V';

private static $CMD_LOCATE = 'L';

private static $CMD_RESET = 'R';

private static $RESPONSE_NOK = 'N';

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Augmente le volume d'un incrément
*
* @return boolean
*/
public function volumeUp()
{
return $this->sendCommand(self::$CMD_VOLUME . "+");
}

/**
* Baisse le volume d'un incrément
*
* @return boolean
*/
public function volumeDown()
{
return $this->sendCommand(self::$CMD_VOLUME . "-");
}

/**
*
* @return boolean
*/
public function setVolume($volume)
{
if ($volume < 0 || $volume > 100) {
return false;
}
return $this->sendCommand(self::$CMD_VOLUME . $volume);
}

public function getVolume(){
return $this->sendCommand(self::$CMD_VOLUME);
}

/**
*
* @return boolean
*/
public function doReset()
{
return $this->sendCommand(self::$CMD_RESET);
}

public function doLocate(){
return $this->sendCommand(self::$CMD_LOCATE);
}

/**
* Envoie une commande au module
*
* @param string $message
*/
private function sendCommand($message)
{
$result = false;
if ($this->openSocket() !== FALSE) {
if (socket_sendto($this->socket, $message, strlen($message), 0, $this->ip, self::$PORT) !== FALSE) {
$result = $this->readAcknoledge();
}
}
$this->closeSocket();
return $result;
}

/**
* Attend la confirmation de la commande
*
* @return boolean
*/
private function readAcknoledge()
{
$buf = "";
$retries = 0;
while ($retries < self::$RETRIES) {
$byteReceived = socket_recvfrom($this->socket, $buf, 2048, 0, $this->ip, self::$PORT);
if ($byteReceived > 0) {
return $buf != self::$RESPONSE_NOK ? $buf : FALSE;
}
usleep(500000);
$retries ++;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) === FALSE) {
$errorcode = socket_last_error();
$errormsg = socket_strerror($errorcode);
echo ("Couldn't create socket: [$errorcode] $errormsg \n");
return false;
}
return true;
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
On créé un fichier ''Command.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicHandler.class.php';

$esp_ip = "192.168.1.200";

$handler = new MusicHandler($esp_ip);

// Exemple de commandes //
//$result = $handler->volumeUp();
//$result = $handler->getVolume();
//$result = $handler->doReset();
//$result = $handler->setVolume(70);

$result = $handler->doLocate();

echo $result !== FALSE ? "ok : $result\n" : "nok\n";
</source>
== Partie Cliente ==
Dans la partie des imports ajoutez la ligne suivante :
<source lang="c">
#include <WiFiUDP.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// Command Server parameters //
const uint16_t CMD_PORT = 5046;
// L'instance du serveur UDP
WiFiUDP udp;
// Liste de commandes
const char CMD_VOLUME = 'V';
const char CMD_LOCATE = 'L';
const char CMD_RESET = 'R';
const char RESPONSE_NOK[] = "N";

// Localisation parameters
uint8_t ledPin = LED_BUILTIN;
const uint16_t BLINK_FREQ = 500;
const uint8_t BLINK_REP = 60;
uint8_t repetition = 0;
uint32_t timer;
bool isLocate = false;
</source>
A la fin de la fonction setup() nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur UDP
initCmdServer();
// On prépare la led de localisation
initLocateLed();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
bool readCmd() {
if (udp.parsePacket() > 0) {
uint8_t len = udp.available();
char c = udp.read();
if (len == 1) {
if (c == CMD_RESET) {
player.softReset();
sendPacket(CMD_RESET);
return true;
} else if (c == CMD_VOLUME) {
sendPacket(volume_level);
return true;
} else if (c == CMD_LOCATE) {
if (!isLocate) {
locate(true);
sendPacket(CMD_LOCATE);
return true;
}
}
} else if (len == 2) {
char value = udp.read();
if (c == CMD_VOLUME) {
if (value == '+' && volume_level != 100) {
setVolume(volume_level + 1);
} else if (value == '-' && volume_level != 0) {
setVolume(volume_level - 1);
} else {
sendNack();
return false;
}
return true;
}
} else {
if (c == CMD_VOLUME) {
char value[4] = "0";
udp.read(value, 3);
uint8_t vol = atoi(value);
if (vol >= 0 && vol <= 100) {
setVolume(vol);
return true;
}
}
}
sendNack();
return false;
}
// Check if locate needs to be done
locate(false);
}
void locate(bool blink) {
if (blink) {
// Initialisation des variables
digitalWrite(ledPin, LOW);
isLocate = true;
repetition = 0;
timer = millis();
} else if (isLocate) {
// Calcule du temps
uint32_t elapsed = millis() - timer;
if (elapsed > BLINK_FREQ) {
repetition++;
if (repetition == BLINK_REP) {
// On a atteint le nombre de clignotements
isLocate = false;
digitalWrite(ledPin, HIGH);
} else {
// On fait clignoter la led
digitalWrite(ledPin, !digitalRead(ledPin));
timer = millis();
}
}
}
}

void setVolume(uint8_t vol) {
volume_level = vol;
Serial.printf("Setting volume to %d\n", volume_level);
player.setVolume(volume_level);
sendPacket(volume_level);
}

void sendNack() {
sendPacket(RESPONSE_NOK);
}

void sendPacket(const char content) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(const char content[]) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(int content) {
char value[4];
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(itoa(content, value, 10));
udp.endPacket();
}

void initCmdServer() {
// Démarrage du serveur TCP
udp.begin(CMD_PORT);
Serial.printf("Ecoute UDP sur le port %d\n", CMD_PORT);
}

void initLocateLed() {
pinMode(ledPin, OUTPUT);
digitalWrite(ledPin, HIGH);
}
</source>
L'ESP est maintenant capable de :
* monter / baisser le volume ;
* de faire un reset du lecteur MP3 (en cas de problème)
* de faire clignoter sa led pour être localisé facilement.

= Enceinte armbian =
Même objectif mais cette fois-ci avec Rygel, un lecteur DLNA.
==Installation ==
Le système:
<pre>
# apt-get update
</pre>
Le lecteur rygel:
<pre>
# apt-get -y install rygel-playbin
</pre>
Les différents plugins. Tout d'abord, récupérer les plugins en fonctions de la distribution:
* Pour le Banana PI:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | awk -F ' - ' '{print $1}')
</pre>
* Pour le Raspberry PI:
<pre>
# plugins=$(apt-cache search gstreamer1.0 | grep plugin | awk -F ' - ' '{print $1}' | grep plugins)
</pre>
Ensuite on procéde à l'installation:
<pre>
# apt-get install ${plugins}
</pre>

== Création du fichier de service ==
Il suffit de créer le fichier ''/etc/systemd/system/rygel.service'':
<pre>
[Unit]
Description=Rygel service
After=network-online.target

[Service]
Type=simple
UMask=007
ExecStart=/usr/bin/rygel -g 5
Restart=on-failure

# Configures the time to wait before service is stopped forcefully.
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
On peut lancer le service et l'activer au démarrage
<pre>
# systemctl start rygel
# systemctl enable rygel
</pre>
== Désactivation des logs ==
Comme l'enceinte n'est pas à proprement parler un serveur exécutant un service critique, on peut désactiver le système de logging pour économiser la durée de vie de la carte SD:
<pre>
# systemctl stop rsyslog
# systemctl disable rsyslog
</pre>
== Ajustement du volume ==
Il faut maintenant mettre le volume au maximum coté Pi avec le mixer ALSA [https://fr.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture wikipedia] :
<pre>
# alsamixer
</pre>
[[Fichier:alsamixer armbian.png|centré]]
== Changement de la carte son par défaut ==
Une fois la carte son USB installée, il suffit d'utiliser la commande suivante pour voir son identifiant:
<pre>
# aplay -l
**** List of PLAYBACK Hardware Devices ****
card 0: sun4icodec [sun4i-codec], device 0: CDC PCM Codec-0 []
Subdevices: 1/1
Subdevice #0: subdevice #0
card 1: Device [USB Audio Device], device 0: USB Audio [USB Audio]
Subdevices: 0/1
Subdevice #0: subdevice #0
</pre>
La carte son avec l'ID ''0'' est celle intégrée au PI, celle avec l'ID ''1'' est la carte USB.
Pour dire à ALSA que c'est la carte avec l'ID ''1'' que l'on veut par défaut, il suffit de créer le fichier ''/etc/asound.conf'' avec les lignes suivantes:
<pre>
defaults.pcm.card 1
defaults.ctl.card 1
</pre>
La configuration est appliquée après un redémarrage !

== WiringPI==
===Installation===
Pour le Banana Pi M1:
<pre>
# cd /opt
# git clone https://github.com/LeMaker/WiringLMK.git
# cd WiringLMK
# chmod +x ./build
# ./build
</pre>
Pour le Raspberry Pi 2:
<pre>
# apt install -y wiringpi
</pre>

=== Utilisation===
Pour la lecture des états
<pre>
# gpio readall
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| | | 3.3v | | | 1 || 2 | | | 5v | | |
| 2 | 8 | SDA.1 | ALT5 | 0 | 3 || 4 | | | 5V | | |
| 3 | 9 | SCL.1 | ALT5 | 0 | 5 || 6 | | | 0v | | |
| 4 | 7 | GPIO. 7 | IN | 0 | 7 || 8 | 1 | ALT2 | TxD | 15 | 14 |
| | | 0v | | | 9 || 10 | 0 | IN | RxD | 16 | 15 |
| 17 | 0 | GPIO. 0 | IN | 0 | 11 || 12 | 0 | IN | GPIO. 1 | 1 | 18 |
| 27 | 2 | GPIO. 2 | IN | 0 | 13 || 14 | | | 0v | | |
| 22 | 3 | GPIO. 3 | IN | 0 | 15 || 16 | 0 | IN | GPIO. 4 | 4 | 23 |
| | | 3.3v | | | 17 || 18 | 0 | IN | GPIO. 5 | 5 | 24 |
| 10 | 12 | MOSI | ALT5 | 0 | 19 || 20 | | | 0v | | |
| 9 | 13 | MISO | ALT5 | 0 | 21 || 22 | 0 | IN | GPIO. 6 | 6 | 25 |
| 11 | 14 | SCLK | ALT5 | 0 | 23 || 24 | 0 | ALT5 | CE0 | 10 | 8 |
| | | 0v | | | 25 || 26 | 0 | ALT5 | CE1 | 11 | 7 |
| 0 | 30 | SDA.0 | IN | 1 | 27 || 28 | 1 | IN | SCL.0 | 31 | 1 |
| 5 | 21 | GPIO.21 | IN | 0 | 29 || 30 | | | 0v | | |
| 6 | 22 | GPIO.22 | ALT4 | 0 | 31 || 32 | 0 | ALT4 | GPIO.26 | 26 | 12 |
| 13 | 23 | GPIO.23 | IN | 0 | 33 || 34 | | | 0v | | |
| 19 | 24 | GPIO.24 | IN | 0 | 35 || 36 | 0 | IN | GPIO.27 | 27 | 16 |
| 26 | 25 | GPIO.25 | IN | 0 | 37 || 38 | 0 | IN | GPIO.28 | 28 | 20 |
| | | 0v | | | 39 || 40 | 0 | IN | GPIO.29 | 29 | 21 |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
</pre>
Ou d'un état:
<pre>
# gpio read 1
0
</pre>
Changement d'état:
<pre>
# gpio -1 write 8 0
</pre>

== Détection de musique ==
Il est possible de détecter si de la musique est en train d'être jouée sur le PI grâce à la commande suivante:
<pre>
# cat /proc/asound/card*/pcm*/sub*/status | grep RUNNING | wc -l
</pre>
Si cette commande renvoie ''1'' cela veut dire que ''state: RUNNING'' est présent dans un des fichiers d'une des cartes son.

Cette commande peu permettre de piloter un amplificateur au travers d'un relais piloté par une GPIO...
Nous aurions le script ''/opt/amp-relay.php''
<source lang="php">
#!/usr/bin/php
<?php

function main($argv){
// Amp relay GPIO
$GPIO = 1;
$cmd = 'cat /proc/asound/card*/pcm*/sub*/status | grep RUNNING | wc -l';
shell_exec('gpio mode '.$GPIO.' output');
shell_exec('gpio write '.$GPIO.' 0');
while(1){
exec($cmd, $output, $ret);
if($ret==0){
shell_exec('gpio write '.$GPIO.' '.$output[0]);
unset($output);
}
usleep(50);
}
}

main($argv);
</source>
avec un petit script systemctl (''/etc/systemd/system/ampli-relay.service''):
<pre>
[Unit]
Description=Aplificator relay service
After=bluetooth.target

[Service]
ExecStart=/opt/amp-relay.php
Restart=on-failure
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
On n'oubliera pas de rendre le fichier exécutable et d'activer le service:
<pre>
# chmod +x /etc/amp-relay.php
# systemctl start amp-relay.service
# systemctl enable amp-relay.service
</pre>

== Ajout du bluetooth ==
=== Paramétrage de la carte===
Il faut d'abord installer blueZ:
<pre>
# apt install -y bluez bluez-tools bluealsa
</pre>
Il faut créer le fichier ''/etc/bluetooth/audio.conf'':
<pre>
[General]
Enable=Source,Sink,Media,Socket
</pre>
éditez le fichier ''/etc/bluetooth/main.conf'' pour modifier les lignes suivantes:
<pre>
...
Class = 0x00041C
...
DiscoverableTimeout = 0
...
PairableTimeout = 0
...
</pre>
Il faut ensuite redémarrer le service ''bluetooth'' pour appairer le téléphone:
<pre>
# systemctl restart bluetooth
</pre>
=== Déclaration de services===
Avant d'aller plus loin, nous allons enregistrer deux commandes en tant que service système:
* ''bluealsa -p a2dp-sink &'' : qui permet de déclarer le PI comme point de terminaison A2DP (musique);
* ''bluealsa-aplay 00:00:00:00:00:00'' : qui permet de laisser passer la musique sur la carte son par défaut.
Pour cela nous allons utiliser la même technique que pour Rygel (plus haut):
* Dans le fichier ''/etc/systemd/system/blue-a2dp.service'':
<pre>
[Unit]
Description=Alsa A2DP service
After=bluetooth.target

[Service]
ExecStart=/usr/bin/bluealsa -p a2dp-sink
Restart=on-failure
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
* Dans le fichier ''/etc/systemd/system/blue-aplay.service'':
<pre>
[Unit]
Description=Alsa Aplay authorization service
After=bluetooth.target

[Service]
ExecStart=/usr/bin/bluealsa-aplay 00:00:00:00:00:00
Restart=on-failure
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
Il ne reste plus qu'à enregistrer les services:
<pre>
# systemctl start blue-a2dp.service
# systemctl start blue-aplay.service
# systemctl enable blue-aplay.service
# systemctl enable blue-a2dp.service
</pre>

=== Appairage ===
Il faut lancer l'utilitaire ''bluetoothctl'':
<pre>
# bluetoothctl
Agent registered
[bluetooth]#
[CHG] Device 0C:2C:54:1B:A3:A9 Connected: yes
[tala_phone]#
</pre>

Iot speaker

2019-07-19T18:35:38Z

Tala : /* Détection de musique */

=Projet=
{|class="wikitable" width="100%"
|-valign=top
! Objectif !! Les acteurs !! Compétences !! Matériel
|-valign=top
||
Construire des enceintes sans-fils (sauf le courant) actives connectées capables de travailler en "groupe"
||
*[[User:Tala | Tala]]
*[[User:Nigdor |Nigdor]]
*[[User:Prandar |Prandar]]
||
*électronique
*C++ (microcontrôleur)
||
* microcontrôleur (esp8266)
* amplificateur audio (XPT8871, PAM8403, ...)
* décodeur MP3 (VS1053B)
* potentiomètre digital (X9C103S)
|}

= Choix de l'amplificateur =
A faire:
*Expliquer la différence entre classe AB et D (qualité sonore vs. éco énergie)
*Faire un tableau récapitulatif des caractéristiques des amplis:
** mono / stéréo / les deux
** tension de fonctionnement / consommation (5v, 12v, 24v, etc...)
** puissance (5w, 20w, 30w, etc...)
** impédance de sortie (2 x 4Ω, 1 x 8Ω, etc...)
** réponse fréquentielle ;
** résistance aux courts-circuits ;
** bruit pop (quand pas de musique);
** besoin d'un dissipateur ou non (effet joule à prévoir...)
** lien vers la documentation si besoin d'info(eg. pour le [https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932])
** le plus important : le ressenti !
==Classe AB==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
TDA7297
|align=center|
[[Fichier:TDA7297.png|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 15W
|align=center|
2A (peak)
|align=center|
6 - 18 V
|align=center|
OUI
|align=center|
Avec µControlleur<br>(p. 3/4)
|align=center|
Obligatoire
|align=center|
[http://www.st.com/content/ccc/resource/technical/document/datasheet/a3/eb/9b/59/dd/26/4a/27/CD00001048.pdf/files/CD00001048.pdf/jcr:content/translations/en.CD00001048.pdf TDA7297]
|align=left|
Super amplification sans distorsion !
<br>
Forte dissipation thermique à pleine puissance :
* 33W d'après la doc;
* vraiment très (trop) fort !
|}
</div>

==Classe D==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
XH-M531 (YDA138)
|align=center|
[[Fichier:XH-M531.jpg|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 10 W<br>
2 x 20 W
|align=center|
8 Ω<br>
4 Ω
|align=center|
12 - 15V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.ksp-electronics.com/product_files/8eeedc66ea8fbcdf2e74294037c2f389 YDA138]
|align=center|
|-valign="top"
|align=center|
PAM8403
|align=center|
[[Fichier:PAM8403.jpg|centré|100px]]
|align=center|
Stéréo
|align=center|
3W(*2 ?)
|align=center|
4 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
Reduit mais présent
|align=center|
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8403.pdf PAM8403]
|align=center|
|-valign="top"
|align=center|
PAM8610
|align=center|
[[Fichier:PAM8610.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 10 W
|align=center|
8 Ω
|align=center|
7 - 15 V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8610.pdf PAM8610]
|align=center|
|-valign="top"
|align=center|
XPT8871
|align=center|
[[Fichier:XPT8871.jpg|centré|120px]]
|align=center|
Mono
|align=center|
3.5w
<br>
5w
|align=center|
3 Ω
<br>
2 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[[Media:XPT8871.pdf|XPT8871]]
|align=left|
*Bien pour la voix, pas top pour la musique
|-valign="top"
|align=center|
TDA8932
|align=center|
[[Fichier:TDA8932.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2*15W
|align=center|
4 Ω
|align=center|
Entre 10 V et 36 V (Rechercher quel est le plus optimal)
|align=center|
OUI
|align=center|
NON
|align=center|

|align=center|
[https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932]
|align=center|
|-valign="top"
|align=center|
TPA3110
|align=center|
[[Fichier:TPA3110.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
15W/ch
|align=center|
8 Ω
|align=center|
16 V
|align=center|
OUI
|align=center|
NON
|align=center|
OUI
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3110d2.pdf TPA3110]
|align=left|
*Amplification moyenne
*Basses creuses
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3116
|align=center|
[[Fichier:TPA3116.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 50W<br>
2 x 15W
|align=center|
4 Ω<br>
8 Ω
|align=center|
21 V<br>
15 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI<br>
NON
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3116d2.pdf TPA3116]
|align=left|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3118
|align=center|
[[Fichier:TPA3118.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 30W
|align=center|
8 Ω
|align=center|
12 - 24 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI
|align=left|
[http://www.ti.com/lit/ds/symlink/tpa3118d2.pdf TPA3118]
|align=center|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|}
</div>

= Potentiomètre digital =
A faire

= Décodeur MP3 =
==Présentation==
Le décodeur MP3 choisi est le VS1053

[[Fichier:vs1053_board.jpg|centré|200px]]

Ce décodeur offre une interface SPI et permet de lire ainsi que d'enregistrer des fichiers aux formats :
* lecture :
**MP3 ;
**Ogg Vorbis (libre de droit) ;
**PCM;
**WAV;
* enregistrement :
**Ogg Vorbis(libre de droit) ;

==Documentation technique==
Voici la [[:Media:vs1053_doc.pdf|documentation du VS1053]], pour ceux qui voudraient écrire une librairie C++ !

== Schéma ==
Les tests ont été réalisés avec un WemOS D1 mini (ESP8266) :
<div align="center">
{|class="wikitable" width="85%"
! ESP8266 !! VS1053 !! Connections
|-valign=top
||
[[Fichier:wemos_D1_R2_mini_diagram.png|centré|470px]]
||
[[Fichier:vs1053_board_diagram.png|centré|300px]]
|align="center"|
{|class="wikitable"
! ESP8266 !! VS1053
|-
|align="center"| D0
|align="center"| XDCS
|-
|align="center"| D1
|align="center"| XoS (Cable Select)
|-
|align="center"| D3
|align="center"| DREQ
|-
|align="center"| D5
|align="center"| SCK (Serial ClocK)
|-
|align="center"| D6
|align="center"| MISO (Master In Slave Out)
|-
|align="center"| D7
|align="center"| MOSI (Master Out Slave In)
|-
|align="center"| RST
|align="center"| XRST
|-
|align="center"| 5V
|align="center"| 5V
|-
|align="center"| G
|align="center"| DGND
|}
|}
</div>
Vous devriez avoir quelque chose comme ça :

[[Fichier:wemos_D1_vs1053_diagram.jpg|centré|400px]]

== Programmation ==
Tout d'abord un grand merci à [https://github.com/baldram/ESP_VS1053_Library ''baldram''] pour sa [[Media:ESP_VS1053_Library.zip|librairie]] que nous allons utiliser !

Le plus simple est de regarder l'exemple ''SimpleMP3Player'' fourni avec la librairie :
<source lang="c">
// La fameuse librairie de baldram
#include <VS1053.h>
// Un MP3 au format binaire dans un tableau (le fichier est livré avec la librairie)
#include <helloMp3.h>
// Définition des port SPI utilisé (ici pour l'ESP8266)
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
// Définition du volume
#define VOLUME 80 // volume level 0-100
// Création de l'objet VS1053
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);

void setup () {
// Démarrage du SPI
SPI.begin();
// démarrage du VS1053
player.begin();
// Ligne nécessaire pour certain lecteur
player.switchToMp3Mode();
player.setVolume(VOLUME);
}

void loop() {
// On joue le MP3 dans le tableau
player.playChunk(helloMp3, sizeof(helloMp3));
// On attend 3 secondes
delay(3000);
}
</source>
Pour que cet exemple fonctionne, il faut soit copier le contenu de ''HelloMp3.h'' dans le fichier exemple, soit copier le fichier dans le répertoire de la librairie dans votre dossier ''Arduino''.

Une fois la compilation terminée, vous devriez entendre ''du bruit'' sortir du VS1053 !

= Flux musical =
La communication se fera en générant un flux entre le programme (PC) et l'enceinte (ESP8266). Ce flux, pour des raisons de simplicité, se fera en TCP car ce protocole gère les retransmissions, les tampons d'entrée / sortie, etc...

A terme, une application temps réel comme la musique mériterait de passer sur de l'UDP. Surtout que, si l'on souhaite utiliser du [https://www.tala-informatique.fr/wiki/index.php/Esp8266_udp_server multicast], pour parler à un groupe d'enceintes, on ne peut le faire qu'en UDP !
== Envoi : serveur en PHP ==
La partie serveur prend un fichier, ici un MP3, lit un morceau du fichier et l'envoi à l'enceinte à travers une socket TCP. Deux paramètres sont à prendre en compte :
*le temps d'attente entre chaque envoi;
*la taille d'un morceau;
Ces paramètres nécessiteront certainement un temps d'ajustement qui sera en fonction de la latence, la congestion du réseau, les capacités des puces impliquées (ici l'ESP8266), etc...
{|style="width:650px" align="center"
|
[[Fichier:warning-icon.png|centré|60px]]
|valign="top" align="justify"|
Les extraits de code qui vont suivre respectent vaguement les préceptes, au combien importants, de la programmation orientée objet et sont fournis à titre indicatif dans l'unique but de démontrer la faisabilité d'un tel projet ! Voici [[:Media:Iot_Speaker.zip | l'archive]] qui contient le code exposé ci-dessous.
|}
=== MusicSender ===
Voici le contenu du fichier ''MusicSender.class.php'' :
<source lang="php">
<?php

class MusicSender
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5045;

// Le temps d'attente en microsecondes entre chaque paquets
private static $SLEEP_INTERVAL = 2500;

// La taille de chacun des paquets
private static $CHUNK_BUFFER = 32768;

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Envoie le MP3 à l'enceinte
*
* @param string $mp3File
* @return boolean
*/
public function play($mp3File)
{
if (is_file($mp3File)) {
// Ouverture du fichier en lecture binaire
$file = fopen($mp3File, 'rb');
if ($file === FALSE) {
echo "Fail reading file " . $file . "\n";
return FALSE;
}
// Ouverture de la socket
$socket = $this->openSocket();
// Tant qu'on est pas à la fin du fichier
while (! feof($file)) {
// Envoie d'un "morceau" de taille CHUNK_BUFFER à l'enceinte
if (@socket_write($this->socket, fread($file, self::$CHUNK_BUFFER), self::$CHUNK_BUFFER) === FALSE) {
// Problème de socket (fermeture, déconnexion, etc...)
return FALSE;
}
usleep(self::$SLEEP_INTERVAL);
}
// Fermeture de la socket
$this->closeSocket();
// Fermeture du fichier
fclose($file);
return TRUE;
}
echo $file." does not exists !\n";
return FALSE;
}

/**
* Lit tous les mp3 présents dans le dossier
*
* @param string $dir
*/
public function readFolder($dir)
{
if (is_dir($dir)) {
// On récupére les fichiers sans les 2 premiers '.' et '..'
$files = array_slice(scandir($dir), 2);
foreach ($files as $file) {
// On créé le chemin absolu
$mp3File = $dir . DIRECTORY_SEPARATOR . $file;
// On test l'extension
if (pathinfo($file)["extension"] == "mp3") {
$this->play($mp3File);
}
}
return true;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) == FALSE) {
echo "socket_create_listen() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
if (socket_connect($this->socket, $this->ip, self::$PORT) == FALSE) {
echo "socket_bind() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
=== Launch.php ===
On créé un fichier ''Launch.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicSender.class.php';

$esp_ip = "192.168.1.200";

$dir = "!!chemin_vers_des_fichiers_mp3!!";

$sender = new MusicSender($esp_ip);

$sender->readFolder($dir);
</source>

== Réception : ESP8266 ==
{|style="width:650px" align="center"
|
[[Fichier:Warning manual.jpg|centré|300px]]
|valign="top" align="justify"|
Soyez sûr de comprendre la section sur [https://www.tala-informatique.fr/wiki/index.php/Arduino_sketch_writing| comment écrire un sketch] avant de poursuivre. Le code ci-dessous fait référence à des parties bien spécifiques, détaillées et expliquées dans la section suscitée.
|}
=== Partie WiFi ===
La première étape consiste à raccorder notre ''ESP'' au réseau WiFi !
<source lang="c">
#include <ESP8266WiFi.h>
#include <WiFiClient.h>

// WiFi Parameters //
const char ssid[] = "cfcasa";
const char password[] = "***********";
IPAddress ip(192, 168, 1, 200);
IPAddress gw(192, 168, 1, 254);
IPAddress mask(255, 255, 252, 0);

void setup() {
// on démarre le port série
Serial.begin(115200);
// On attend "un peu" que le buffer soit prêt
delay(10);
// On démarre le WiFi
initWiFi();
}

void loop() {
}

void initWiFi() {
// On efface la configuration précédente
WiFi.disconnect(true);
Serial.printf("\nConnexion a %s", ssid);
// Initialisation de la connection
WiFi.config(ip, gw, mask, gw);
WiFi.begin(ssid, password);
// Test pour déterminer quand la connection est prete
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(".");
}
// Affichage des informations
Serial.printf(" connecté\nAdresse IP: %s\n", WiFi.localIP().toString().c_str());
}
</source>
=== Lecteur MP3 ===
Vient ensuite la partie du lecteur MP3. Dans la partie des imports, ajoutez la ligne suivante :
<source lang="c">
#include <VS1053.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Parameters //
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
#define VOLUME 70 // volume level 0-100
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);
uint8_t volume_level = VOLUME;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le shield MP3
initMP3();
</source>
A la suite, on insère la fonction suivante :
<source lang="c">
void initMP3() {
SPI.begin();
// Démarrage du lecteur MP3
player.begin();
player.switchToMp3Mode();
player.setVolume(volume_level);
}
</source>
=== Récupération du stream MP3 ===
On va maintenant récupérer le flux envoyé depuis le serveur. Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Server parameters //
const uint16_t MP3_PORT = 5045;
WiFiServer server(MP3_PORT);
const uint16_t BUFFER_SIZE = 16384;
//const uint16_t BUFFER_SIZE = 32768;
byte buffer[BUFFER_SIZE + 1];
uint16_t byteRead = 0;
bool isBufferReady = false;
WiFiClient client;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur TCP
initMp3Server();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
void initMp3Server() {
// Démarrage du serveur TCP
server.begin();
Serial.printf("Ecoute TCP sur le port %d\n", MP3_PORT);
}

void readMp3() {
// Un client est connecté
if (client) {
// Si le client est toujours connecté...
if (client.connected()) {
// Tant que l'on reçoit de la musique
while (client.available() > 0) {
// On rempli le buffer avec le contenu du paquet TCP
buffer[byteRead++] = client.read();
// Si le buffer est plein
if (byteRead == BUFFER_SIZE) {
// On previent que le buffer est plein
isBufferReady = true;
// On sort de la boucle
break;
}
}
// Si le buffer est plein
if (isBufferReady) {
// On envoi tout au lecteur MP3
player.playChunk(buffer, byteRead);
// On RAZ le compteur de bytes
byteRead = 0;
}
} else {
// Si le client est déconneté
client = server.available();
// On prévient que le buffer est vide
isBufferReady = false;
// On RAZ le compteur de bytes
byteRead = 0;
Serial.println(F("Client disconnected"));
}
} else {
// On test la présence d'un client
client = server.available();
if (client) {
// Un client est connecté !
Serial.println(F("New client !"));
}
}
}
</source>
Enfin, on ajoute le ligne suivante dans la fonction ''loop()'' :
<source lang="c">
readMp3();
</source>
A ce stade, l'ESP devrait être capable de récupérer le flux et de le jouer !

= Envoi de commandes =
Envoyer de la musique c'est bien, pouvoir régler le volume c'est encore mieux !

La façon la plus simple d'adresser le problème c'est d'utiliser un autre port et, comme les messages sont petits, d'utiliser UDP.
== Partie Serveur ==
Dans la même veine, voici la classe qui permet d'envoyer les commandes :
<source lang="php">
<?php

class MusicHandler
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5046;

// Le port de l'enceinte connectée
private static $RETRIES = 3;

// Liste de commandes
private static $CMD_VOLUME = 'V';

private static $CMD_LOCATE = 'L';

private static $CMD_RESET = 'R';

private static $RESPONSE_NOK = 'N';

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Augmente le volume d'un incrément
*
* @return boolean
*/
public function volumeUp()
{
return $this->sendCommand(self::$CMD_VOLUME . "+");
}

/**
* Baisse le volume d'un incrément
*
* @return boolean
*/
public function volumeDown()
{
return $this->sendCommand(self::$CMD_VOLUME . "-");
}

/**
*
* @return boolean
*/
public function setVolume($volume)
{
if ($volume < 0 || $volume > 100) {
return false;
}
return $this->sendCommand(self::$CMD_VOLUME . $volume);
}

public function getVolume(){
return $this->sendCommand(self::$CMD_VOLUME);
}

/**
*
* @return boolean
*/
public function doReset()
{
return $this->sendCommand(self::$CMD_RESET);
}

public function doLocate(){
return $this->sendCommand(self::$CMD_LOCATE);
}

/**
* Envoie une commande au module
*
* @param string $message
*/
private function sendCommand($message)
{
$result = false;
if ($this->openSocket() !== FALSE) {
if (socket_sendto($this->socket, $message, strlen($message), 0, $this->ip, self::$PORT) !== FALSE) {
$result = $this->readAcknoledge();
}
}
$this->closeSocket();
return $result;
}

/**
* Attend la confirmation de la commande
*
* @return boolean
*/
private function readAcknoledge()
{
$buf = "";
$retries = 0;
while ($retries < self::$RETRIES) {
$byteReceived = socket_recvfrom($this->socket, $buf, 2048, 0, $this->ip, self::$PORT);
if ($byteReceived > 0) {
return $buf != self::$RESPONSE_NOK ? $buf : FALSE;
}
usleep(500000);
$retries ++;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) === FALSE) {
$errorcode = socket_last_error();
$errormsg = socket_strerror($errorcode);
echo ("Couldn't create socket: [$errorcode] $errormsg \n");
return false;
}
return true;
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
On créé un fichier ''Command.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicHandler.class.php';

$esp_ip = "192.168.1.200";

$handler = new MusicHandler($esp_ip);

// Exemple de commandes //
//$result = $handler->volumeUp();
//$result = $handler->getVolume();
//$result = $handler->doReset();
//$result = $handler->setVolume(70);

$result = $handler->doLocate();

echo $result !== FALSE ? "ok : $result\n" : "nok\n";
</source>
== Partie Cliente ==
Dans la partie des imports ajoutez la ligne suivante :
<source lang="c">
#include <WiFiUDP.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// Command Server parameters //
const uint16_t CMD_PORT = 5046;
// L'instance du serveur UDP
WiFiUDP udp;
// Liste de commandes
const char CMD_VOLUME = 'V';
const char CMD_LOCATE = 'L';
const char CMD_RESET = 'R';
const char RESPONSE_NOK[] = "N";

// Localisation parameters
uint8_t ledPin = LED_BUILTIN;
const uint16_t BLINK_FREQ = 500;
const uint8_t BLINK_REP = 60;
uint8_t repetition = 0;
uint32_t timer;
bool isLocate = false;
</source>
A la fin de la fonction setup() nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur UDP
initCmdServer();
// On prépare la led de localisation
initLocateLed();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
bool readCmd() {
if (udp.parsePacket() > 0) {
uint8_t len = udp.available();
char c = udp.read();
if (len == 1) {
if (c == CMD_RESET) {
player.softReset();
sendPacket(CMD_RESET);
return true;
} else if (c == CMD_VOLUME) {
sendPacket(volume_level);
return true;
} else if (c == CMD_LOCATE) {
if (!isLocate) {
locate(true);
sendPacket(CMD_LOCATE);
return true;
}
}
} else if (len == 2) {
char value = udp.read();
if (c == CMD_VOLUME) {
if (value == '+' && volume_level != 100) {
setVolume(volume_level + 1);
} else if (value == '-' && volume_level != 0) {
setVolume(volume_level - 1);
} else {
sendNack();
return false;
}
return true;
}
} else {
if (c == CMD_VOLUME) {
char value[4] = "0";
udp.read(value, 3);
uint8_t vol = atoi(value);
if (vol >= 0 && vol <= 100) {
setVolume(vol);
return true;
}
}
}
sendNack();
return false;
}
// Check if locate needs to be done
locate(false);
}
void locate(bool blink) {
if (blink) {
// Initialisation des variables
digitalWrite(ledPin, LOW);
isLocate = true;
repetition = 0;
timer = millis();
} else if (isLocate) {
// Calcule du temps
uint32_t elapsed = millis() - timer;
if (elapsed > BLINK_FREQ) {
repetition++;
if (repetition == BLINK_REP) {
// On a atteint le nombre de clignotements
isLocate = false;
digitalWrite(ledPin, HIGH);
} else {
// On fait clignoter la led
digitalWrite(ledPin, !digitalRead(ledPin));
timer = millis();
}
}
}
}

void setVolume(uint8_t vol) {
volume_level = vol;
Serial.printf("Setting volume to %d\n", volume_level);
player.setVolume(volume_level);
sendPacket(volume_level);
}

void sendNack() {
sendPacket(RESPONSE_NOK);
}

void sendPacket(const char content) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(const char content[]) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(int content) {
char value[4];
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(itoa(content, value, 10));
udp.endPacket();
}

void initCmdServer() {
// Démarrage du serveur TCP
udp.begin(CMD_PORT);
Serial.printf("Ecoute UDP sur le port %d\n", CMD_PORT);
}

void initLocateLed() {
pinMode(ledPin, OUTPUT);
digitalWrite(ledPin, HIGH);
}
</source>
L'ESP est maintenant capable de :
* monter / baisser le volume ;
* de faire un reset du lecteur MP3 (en cas de problème)
* de faire clignoter sa led pour être localisé facilement.

= Enceinte armbian =
Même objectif mais cette fois-ci avec Rygel, un lecteur DLNA.
==Installation ==
Le système:
<pre>
# apt-get update
</pre>
Le lecteur rygel:
<pre>
# apt-get -y install rygel-playbin
</pre>
Les différents plugins. Tout d'abord, récupérer les plugins en fonctions de la distribution:
* Pour le Banana PI:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | awk -F ' - ' '{print $1}')
</pre>
* Pour le Raspberry PI:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | grep -v python | awk -F ' - ' '{print $1}')
</pre>
Ensuite on procéde à l'installation:
<pre>
# apt-get install ${plugins}
</pre>

== Création du fichier de service ==
Il suffit de créer le fichier ''/etc/systemd/system/rygel.service'':
<pre>
[Unit]
Description=Rygel service
After=network-online.target

[Service]
Type=simple
UMask=007
ExecStart=/usr/bin/rygel -g 5
Restart=on-failure

# Configures the time to wait before service is stopped forcefully.
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
On peut lancer le service et l'activer au démarrage
<pre>
# systemctl start rygel
# systemctl enable rygel
</pre>
== Désactivation des logs ==
Comme l'enceinte n'est pas à proprement parler un serveur exécutant un service critique, on peut désactiver le système de logging pour économiser la durée de vie de la carte SD:
<pre>
# systemctl stop rsyslog
# systemctl disable rsyslog
</pre>
== Ajustement du volume ==
Il faut maintenant mettre le volume au maximum coté Pi avec le mixer ALSA [https://fr.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture wikipedia] :
<pre>
# alsamixer
</pre>
[[Fichier:alsamixer armbian.png|centré]]
== Changement de la carte son par défaut ==
Une fois la carte son USB installée, il suffit d'utiliser la commande suivante pour voir son identifiant:
<pre>
# aplay -l
**** List of PLAYBACK Hardware Devices ****
card 0: sun4icodec [sun4i-codec], device 0: CDC PCM Codec-0 []
Subdevices: 1/1
Subdevice #0: subdevice #0
card 1: Device [USB Audio Device], device 0: USB Audio [USB Audio]
Subdevices: 0/1
Subdevice #0: subdevice #0
</pre>
La carte son avec l'ID ''0'' est celle intégrée au PI, celle avec l'ID ''1'' est la carte USB.
Pour dire à ALSA que c'est la carte avec l'ID ''1'' que l'on veut par défaut, il suffit de créer le fichier ''/etc/asound.conf'' avec les lignes suivantes:
<pre>
defaults.pcm.card 1
defaults.ctl.card 1
</pre>
La configuration est appliquée après un redémarrage !

== WiringPI==
===Installation===
Pour le Banana Pi M1:
<pre>
# cd /opt
# git clone https://github.com/LeMaker/WiringLMK.git
# cd WiringLMK
# chmod +x ./build
# ./build
</pre>
Pour le Raspberry Pi 2:
<pre>
# apt install -y wiringpi
</pre>

=== Utilisation===
Pour la lecture des états
<pre>
# gpio readall
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| | | 3.3v | | | 1 || 2 | | | 5v | | |
| 2 | 8 | SDA.1 | ALT5 | 0 | 3 || 4 | | | 5V | | |
| 3 | 9 | SCL.1 | ALT5 | 0 | 5 || 6 | | | 0v | | |
| 4 | 7 | GPIO. 7 | IN | 0 | 7 || 8 | 1 | ALT2 | TxD | 15 | 14 |
| | | 0v | | | 9 || 10 | 0 | IN | RxD | 16 | 15 |
| 17 | 0 | GPIO. 0 | IN | 0 | 11 || 12 | 0 | IN | GPIO. 1 | 1 | 18 |
| 27 | 2 | GPIO. 2 | IN | 0 | 13 || 14 | | | 0v | | |
| 22 | 3 | GPIO. 3 | IN | 0 | 15 || 16 | 0 | IN | GPIO. 4 | 4 | 23 |
| | | 3.3v | | | 17 || 18 | 0 | IN | GPIO. 5 | 5 | 24 |
| 10 | 12 | MOSI | ALT5 | 0 | 19 || 20 | | | 0v | | |
| 9 | 13 | MISO | ALT5 | 0 | 21 || 22 | 0 | IN | GPIO. 6 | 6 | 25 |
| 11 | 14 | SCLK | ALT5 | 0 | 23 || 24 | 0 | ALT5 | CE0 | 10 | 8 |
| | | 0v | | | 25 || 26 | 0 | ALT5 | CE1 | 11 | 7 |
| 0 | 30 | SDA.0 | IN | 1 | 27 || 28 | 1 | IN | SCL.0 | 31 | 1 |
| 5 | 21 | GPIO.21 | IN | 0 | 29 || 30 | | | 0v | | |
| 6 | 22 | GPIO.22 | ALT4 | 0 | 31 || 32 | 0 | ALT4 | GPIO.26 | 26 | 12 |
| 13 | 23 | GPIO.23 | IN | 0 | 33 || 34 | | | 0v | | |
| 19 | 24 | GPIO.24 | IN | 0 | 35 || 36 | 0 | IN | GPIO.27 | 27 | 16 |
| 26 | 25 | GPIO.25 | IN | 0 | 37 || 38 | 0 | IN | GPIO.28 | 28 | 20 |
| | | 0v | | | 39 || 40 | 0 | IN | GPIO.29 | 29 | 21 |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
</pre>
Ou d'un état:
<pre>
# gpio read 1
0
</pre>
Changement d'état:
<pre>
# gpio -1 write 8 0
</pre>

== Détection de musique ==
Il est possible de détecter si de la musique est en train d'être jouée sur le PI grâce à la commande suivante:
<pre>
# cat /proc/asound/card*/pcm*/sub*/status | grep RUNNING | wc -l
</pre>
Si cette commande renvoie ''1'' cela veut dire que ''state: RUNNING'' est présent dans un des fichiers d'une des cartes son.

Cette commande peu permettre de piloter un amplificateur au travers d'un relais piloté par une GPIO...
Nous aurions le script ''/opt/amp-relay.php''
<source lang="php">
#!/usr/bin/php
<?php

function main($argv){
// Amp relay GPIO
$GPIO = 1;
$cmd = 'cat /proc/asound/card*/pcm*/sub*/status | grep RUNNING | wc -l';
shell_exec('gpio mode '.$GPIO.' output');
shell_exec('gpio write '.$GPIO.' 0');
while(1){
exec($cmd, $output, $ret);
if($ret==0){
shell_exec('gpio write '.$GPIO.' '.$output[0]);
unset($output);
}
usleep(50);
}
}

main($argv);
</source>
avec un petit script systemctl (''/etc/systemd/system/ampli-relay.service''):
<pre>
[Unit]
Description=Aplificator relay service
After=bluetooth.target

[Service]
ExecStart=/opt/amp-relay.php
Restart=on-failure
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
On n'oubliera pas de rendre le fichier exécutable et d'activer le service:
<pre>
# chmod +x /etc/amp-relay.php
# systemctl start amp-relay.service
# systemctl enable amp-relay.service
</pre>

== Ajout du bluetooth ==
=== Paramétrage de la carte===
Il faut d'abord installer blueZ:
<pre>
# apt install -y bluez bluez-tools bluealsa
</pre>
Il faut créer le fichier ''/etc/bluetooth/audio.conf'':
<pre>
[General]
Enable=Source,Sink,Media,Socket
</pre>
éditez le fichier ''/etc/bluetooth/main.conf'' pour modifier les lignes suivantes:
<pre>
...
Class = 0x00041C
...
DiscoverableTimeout = 0
...
PairableTimeout = 0
...
</pre>
Il faut ensuite redémarrer le service ''bluetooth'' pour appairer le téléphone:
<pre>
# systemctl restart bluetooth
</pre>
=== Déclaration de services===
Avant d'aller plus loin, nous allons enregistrer deux commandes en tant que service système:
* ''bluealsa -p a2dp-sink &'' : qui permet de déclarer le PI comme point de terminaison A2DP (musique);
* ''bluealsa-aplay 00:00:00:00:00:00'' : qui permet de laisser passer la musique sur la carte son par défaut.
Pour cela nous allons utiliser la même technique que pour Rygel (plus haut):
* Dans le fichier ''/etc/systemd/system/blue-a2dp.service'':
<pre>
[Unit]
Description=Alsa A2DP service
After=bluetooth.target

[Service]
ExecStart=/usr/bin/bluealsa -p a2dp-sink
Restart=on-failure
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
* Dans le fichier ''/etc/systemd/system/blue-aplay.service'':
<pre>
[Unit]
Description=Alsa Aplay authorization service
After=bluetooth.target

[Service]
ExecStart=/usr/bin/bluealsa-aplay 00:00:00:00:00:00
Restart=on-failure
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
Il ne reste plus qu'à enregistrer les services:
<pre>
# systemctl start blue-a2dp.service
# systemctl start blue-aplay.service
# systemctl enable blue-aplay.service
# systemctl enable blue-a2dp.service
</pre>

=== Appairage ===
Il faut lancer l'utilitaire ''bluetoothctl'':
<pre>
# bluetoothctl
Agent registered
[bluetooth]#
[CHG] Device 0C:2C:54:1B:A3:A9 Connected: yes
[tala_phone]#
</pre>

Iot speaker

2019-07-19T18:31:21Z

Tala : /* Détection de musique */

=Projet=
{|class="wikitable" width="100%"
|-valign=top
! Objectif !! Les acteurs !! Compétences !! Matériel
|-valign=top
||
Construire des enceintes sans-fils (sauf le courant) actives connectées capables de travailler en "groupe"
||
*[[User:Tala | Tala]]
*[[User:Nigdor |Nigdor]]
*[[User:Prandar |Prandar]]
||
*électronique
*C++ (microcontrôleur)
||
* microcontrôleur (esp8266)
* amplificateur audio (XPT8871, PAM8403, ...)
* décodeur MP3 (VS1053B)
* potentiomètre digital (X9C103S)
|}

= Choix de l'amplificateur =
A faire:
*Expliquer la différence entre classe AB et D (qualité sonore vs. éco énergie)
*Faire un tableau récapitulatif des caractéristiques des amplis:
** mono / stéréo / les deux
** tension de fonctionnement / consommation (5v, 12v, 24v, etc...)
** puissance (5w, 20w, 30w, etc...)
** impédance de sortie (2 x 4Ω, 1 x 8Ω, etc...)
** réponse fréquentielle ;
** résistance aux courts-circuits ;
** bruit pop (quand pas de musique);
** besoin d'un dissipateur ou non (effet joule à prévoir...)
** lien vers la documentation si besoin d'info(eg. pour le [https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932])
** le plus important : le ressenti !
==Classe AB==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
TDA7297
|align=center|
[[Fichier:TDA7297.png|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 15W
|align=center|
2A (peak)
|align=center|
6 - 18 V
|align=center|
OUI
|align=center|
Avec µControlleur<br>(p. 3/4)
|align=center|
Obligatoire
|align=center|
[http://www.st.com/content/ccc/resource/technical/document/datasheet/a3/eb/9b/59/dd/26/4a/27/CD00001048.pdf/files/CD00001048.pdf/jcr:content/translations/en.CD00001048.pdf TDA7297]
|align=left|
Super amplification sans distorsion !
<br>
Forte dissipation thermique à pleine puissance :
* 33W d'après la doc;
* vraiment très (trop) fort !
|}
</div>

==Classe D==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
XH-M531 (YDA138)
|align=center|
[[Fichier:XH-M531.jpg|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 10 W<br>
2 x 20 W
|align=center|
8 Ω<br>
4 Ω
|align=center|
12 - 15V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.ksp-electronics.com/product_files/8eeedc66ea8fbcdf2e74294037c2f389 YDA138]
|align=center|
|-valign="top"
|align=center|
PAM8403
|align=center|
[[Fichier:PAM8403.jpg|centré|100px]]
|align=center|
Stéréo
|align=center|
3W(*2 ?)
|align=center|
4 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
Reduit mais présent
|align=center|
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8403.pdf PAM8403]
|align=center|
|-valign="top"
|align=center|
PAM8610
|align=center|
[[Fichier:PAM8610.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 10 W
|align=center|
8 Ω
|align=center|
7 - 15 V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8610.pdf PAM8610]
|align=center|
|-valign="top"
|align=center|
XPT8871
|align=center|
[[Fichier:XPT8871.jpg|centré|120px]]
|align=center|
Mono
|align=center|
3.5w
<br>
5w
|align=center|
3 Ω
<br>
2 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[[Media:XPT8871.pdf|XPT8871]]
|align=left|
*Bien pour la voix, pas top pour la musique
|-valign="top"
|align=center|
TDA8932
|align=center|
[[Fichier:TDA8932.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2*15W
|align=center|
4 Ω
|align=center|
Entre 10 V et 36 V (Rechercher quel est le plus optimal)
|align=center|
OUI
|align=center|
NON
|align=center|

|align=center|
[https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932]
|align=center|
|-valign="top"
|align=center|
TPA3110
|align=center|
[[Fichier:TPA3110.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
15W/ch
|align=center|
8 Ω
|align=center|
16 V
|align=center|
OUI
|align=center|
NON
|align=center|
OUI
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3110d2.pdf TPA3110]
|align=left|
*Amplification moyenne
*Basses creuses
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3116
|align=center|
[[Fichier:TPA3116.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 50W<br>
2 x 15W
|align=center|
4 Ω<br>
8 Ω
|align=center|
21 V<br>
15 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI<br>
NON
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3116d2.pdf TPA3116]
|align=left|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3118
|align=center|
[[Fichier:TPA3118.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 30W
|align=center|
8 Ω
|align=center|
12 - 24 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI
|align=left|
[http://www.ti.com/lit/ds/symlink/tpa3118d2.pdf TPA3118]
|align=center|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|}
</div>

= Potentiomètre digital =
A faire

= Décodeur MP3 =
==Présentation==
Le décodeur MP3 choisi est le VS1053

[[Fichier:vs1053_board.jpg|centré|200px]]

Ce décodeur offre une interface SPI et permet de lire ainsi que d'enregistrer des fichiers aux formats :
* lecture :
**MP3 ;
**Ogg Vorbis (libre de droit) ;
**PCM;
**WAV;
* enregistrement :
**Ogg Vorbis(libre de droit) ;

==Documentation technique==
Voici la [[:Media:vs1053_doc.pdf|documentation du VS1053]], pour ceux qui voudraient écrire une librairie C++ !

== Schéma ==
Les tests ont été réalisés avec un WemOS D1 mini (ESP8266) :
<div align="center">
{|class="wikitable" width="85%"
! ESP8266 !! VS1053 !! Connections
|-valign=top
||
[[Fichier:wemos_D1_R2_mini_diagram.png|centré|470px]]
||
[[Fichier:vs1053_board_diagram.png|centré|300px]]
|align="center"|
{|class="wikitable"
! ESP8266 !! VS1053
|-
|align="center"| D0
|align="center"| XDCS
|-
|align="center"| D1
|align="center"| XoS (Cable Select)
|-
|align="center"| D3
|align="center"| DREQ
|-
|align="center"| D5
|align="center"| SCK (Serial ClocK)
|-
|align="center"| D6
|align="center"| MISO (Master In Slave Out)
|-
|align="center"| D7
|align="center"| MOSI (Master Out Slave In)
|-
|align="center"| RST
|align="center"| XRST
|-
|align="center"| 5V
|align="center"| 5V
|-
|align="center"| G
|align="center"| DGND
|}
|}
</div>
Vous devriez avoir quelque chose comme ça :

[[Fichier:wemos_D1_vs1053_diagram.jpg|centré|400px]]

== Programmation ==
Tout d'abord un grand merci à [https://github.com/baldram/ESP_VS1053_Library ''baldram''] pour sa [[Media:ESP_VS1053_Library.zip|librairie]] que nous allons utiliser !

Le plus simple est de regarder l'exemple ''SimpleMP3Player'' fourni avec la librairie :
<source lang="c">
// La fameuse librairie de baldram
#include <VS1053.h>
// Un MP3 au format binaire dans un tableau (le fichier est livré avec la librairie)
#include <helloMp3.h>
// Définition des port SPI utilisé (ici pour l'ESP8266)
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
// Définition du volume
#define VOLUME 80 // volume level 0-100
// Création de l'objet VS1053
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);

void setup () {
// Démarrage du SPI
SPI.begin();
// démarrage du VS1053
player.begin();
// Ligne nécessaire pour certain lecteur
player.switchToMp3Mode();
player.setVolume(VOLUME);
}

void loop() {
// On joue le MP3 dans le tableau
player.playChunk(helloMp3, sizeof(helloMp3));
// On attend 3 secondes
delay(3000);
}
</source>
Pour que cet exemple fonctionne, il faut soit copier le contenu de ''HelloMp3.h'' dans le fichier exemple, soit copier le fichier dans le répertoire de la librairie dans votre dossier ''Arduino''.

Une fois la compilation terminée, vous devriez entendre ''du bruit'' sortir du VS1053 !

= Flux musical =
La communication se fera en générant un flux entre le programme (PC) et l'enceinte (ESP8266). Ce flux, pour des raisons de simplicité, se fera en TCP car ce protocole gère les retransmissions, les tampons d'entrée / sortie, etc...

A terme, une application temps réel comme la musique mériterait de passer sur de l'UDP. Surtout que, si l'on souhaite utiliser du [https://www.tala-informatique.fr/wiki/index.php/Esp8266_udp_server multicast], pour parler à un groupe d'enceintes, on ne peut le faire qu'en UDP !
== Envoi : serveur en PHP ==
La partie serveur prend un fichier, ici un MP3, lit un morceau du fichier et l'envoi à l'enceinte à travers une socket TCP. Deux paramètres sont à prendre en compte :
*le temps d'attente entre chaque envoi;
*la taille d'un morceau;
Ces paramètres nécessiteront certainement un temps d'ajustement qui sera en fonction de la latence, la congestion du réseau, les capacités des puces impliquées (ici l'ESP8266), etc...
{|style="width:650px" align="center"
|
[[Fichier:warning-icon.png|centré|60px]]
|valign="top" align="justify"|
Les extraits de code qui vont suivre respectent vaguement les préceptes, au combien importants, de la programmation orientée objet et sont fournis à titre indicatif dans l'unique but de démontrer la faisabilité d'un tel projet ! Voici [[:Media:Iot_Speaker.zip | l'archive]] qui contient le code exposé ci-dessous.
|}
=== MusicSender ===
Voici le contenu du fichier ''MusicSender.class.php'' :
<source lang="php">
<?php

class MusicSender
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5045;

// Le temps d'attente en microsecondes entre chaque paquets
private static $SLEEP_INTERVAL = 2500;

// La taille de chacun des paquets
private static $CHUNK_BUFFER = 32768;

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Envoie le MP3 à l'enceinte
*
* @param string $mp3File
* @return boolean
*/
public function play($mp3File)
{
if (is_file($mp3File)) {
// Ouverture du fichier en lecture binaire
$file = fopen($mp3File, 'rb');
if ($file === FALSE) {
echo "Fail reading file " . $file . "\n";
return FALSE;
}
// Ouverture de la socket
$socket = $this->openSocket();
// Tant qu'on est pas à la fin du fichier
while (! feof($file)) {
// Envoie d'un "morceau" de taille CHUNK_BUFFER à l'enceinte
if (@socket_write($this->socket, fread($file, self::$CHUNK_BUFFER), self::$CHUNK_BUFFER) === FALSE) {
// Problème de socket (fermeture, déconnexion, etc...)
return FALSE;
}
usleep(self::$SLEEP_INTERVAL);
}
// Fermeture de la socket
$this->closeSocket();
// Fermeture du fichier
fclose($file);
return TRUE;
}
echo $file." does not exists !\n";
return FALSE;
}

/**
* Lit tous les mp3 présents dans le dossier
*
* @param string $dir
*/
public function readFolder($dir)
{
if (is_dir($dir)) {
// On récupére les fichiers sans les 2 premiers '.' et '..'
$files = array_slice(scandir($dir), 2);
foreach ($files as $file) {
// On créé le chemin absolu
$mp3File = $dir . DIRECTORY_SEPARATOR . $file;
// On test l'extension
if (pathinfo($file)["extension"] == "mp3") {
$this->play($mp3File);
}
}
return true;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) == FALSE) {
echo "socket_create_listen() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
if (socket_connect($this->socket, $this->ip, self::$PORT) == FALSE) {
echo "socket_bind() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
=== Launch.php ===
On créé un fichier ''Launch.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicSender.class.php';

$esp_ip = "192.168.1.200";

$dir = "!!chemin_vers_des_fichiers_mp3!!";

$sender = new MusicSender($esp_ip);

$sender->readFolder($dir);
</source>

== Réception : ESP8266 ==
{|style="width:650px" align="center"
|
[[Fichier:Warning manual.jpg|centré|300px]]
|valign="top" align="justify"|
Soyez sûr de comprendre la section sur [https://www.tala-informatique.fr/wiki/index.php/Arduino_sketch_writing| comment écrire un sketch] avant de poursuivre. Le code ci-dessous fait référence à des parties bien spécifiques, détaillées et expliquées dans la section suscitée.
|}
=== Partie WiFi ===
La première étape consiste à raccorder notre ''ESP'' au réseau WiFi !
<source lang="c">
#include <ESP8266WiFi.h>
#include <WiFiClient.h>

// WiFi Parameters //
const char ssid[] = "cfcasa";
const char password[] = "***********";
IPAddress ip(192, 168, 1, 200);
IPAddress gw(192, 168, 1, 254);
IPAddress mask(255, 255, 252, 0);

void setup() {
// on démarre le port série
Serial.begin(115200);
// On attend "un peu" que le buffer soit prêt
delay(10);
// On démarre le WiFi
initWiFi();
}

void loop() {
}

void initWiFi() {
// On efface la configuration précédente
WiFi.disconnect(true);
Serial.printf("\nConnexion a %s", ssid);
// Initialisation de la connection
WiFi.config(ip, gw, mask, gw);
WiFi.begin(ssid, password);
// Test pour déterminer quand la connection est prete
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(".");
}
// Affichage des informations
Serial.printf(" connecté\nAdresse IP: %s\n", WiFi.localIP().toString().c_str());
}
</source>
=== Lecteur MP3 ===
Vient ensuite la partie du lecteur MP3. Dans la partie des imports, ajoutez la ligne suivante :
<source lang="c">
#include <VS1053.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Parameters //
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
#define VOLUME 70 // volume level 0-100
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);
uint8_t volume_level = VOLUME;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le shield MP3
initMP3();
</source>
A la suite, on insère la fonction suivante :
<source lang="c">
void initMP3() {
SPI.begin();
// Démarrage du lecteur MP3
player.begin();
player.switchToMp3Mode();
player.setVolume(volume_level);
}
</source>
=== Récupération du stream MP3 ===
On va maintenant récupérer le flux envoyé depuis le serveur. Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Server parameters //
const uint16_t MP3_PORT = 5045;
WiFiServer server(MP3_PORT);
const uint16_t BUFFER_SIZE = 16384;
//const uint16_t BUFFER_SIZE = 32768;
byte buffer[BUFFER_SIZE + 1];
uint16_t byteRead = 0;
bool isBufferReady = false;
WiFiClient client;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur TCP
initMp3Server();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
void initMp3Server() {
// Démarrage du serveur TCP
server.begin();
Serial.printf("Ecoute TCP sur le port %d\n", MP3_PORT);
}

void readMp3() {
// Un client est connecté
if (client) {
// Si le client est toujours connecté...
if (client.connected()) {
// Tant que l'on reçoit de la musique
while (client.available() > 0) {
// On rempli le buffer avec le contenu du paquet TCP
buffer[byteRead++] = client.read();
// Si le buffer est plein
if (byteRead == BUFFER_SIZE) {
// On previent que le buffer est plein
isBufferReady = true;
// On sort de la boucle
break;
}
}
// Si le buffer est plein
if (isBufferReady) {
// On envoi tout au lecteur MP3
player.playChunk(buffer, byteRead);
// On RAZ le compteur de bytes
byteRead = 0;
}
} else {
// Si le client est déconneté
client = server.available();
// On prévient que le buffer est vide
isBufferReady = false;
// On RAZ le compteur de bytes
byteRead = 0;
Serial.println(F("Client disconnected"));
}
} else {
// On test la présence d'un client
client = server.available();
if (client) {
// Un client est connecté !
Serial.println(F("New client !"));
}
}
}
</source>
Enfin, on ajoute le ligne suivante dans la fonction ''loop()'' :
<source lang="c">
readMp3();
</source>
A ce stade, l'ESP devrait être capable de récupérer le flux et de le jouer !

= Envoi de commandes =
Envoyer de la musique c'est bien, pouvoir régler le volume c'est encore mieux !

La façon la plus simple d'adresser le problème c'est d'utiliser un autre port et, comme les messages sont petits, d'utiliser UDP.
== Partie Serveur ==
Dans la même veine, voici la classe qui permet d'envoyer les commandes :
<source lang="php">
<?php

class MusicHandler
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5046;

// Le port de l'enceinte connectée
private static $RETRIES = 3;

// Liste de commandes
private static $CMD_VOLUME = 'V';

private static $CMD_LOCATE = 'L';

private static $CMD_RESET = 'R';

private static $RESPONSE_NOK = 'N';

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Augmente le volume d'un incrément
*
* @return boolean
*/
public function volumeUp()
{
return $this->sendCommand(self::$CMD_VOLUME . "+");
}

/**
* Baisse le volume d'un incrément
*
* @return boolean
*/
public function volumeDown()
{
return $this->sendCommand(self::$CMD_VOLUME . "-");
}

/**
*
* @return boolean
*/
public function setVolume($volume)
{
if ($volume < 0 || $volume > 100) {
return false;
}
return $this->sendCommand(self::$CMD_VOLUME . $volume);
}

public function getVolume(){
return $this->sendCommand(self::$CMD_VOLUME);
}

/**
*
* @return boolean
*/
public function doReset()
{
return $this->sendCommand(self::$CMD_RESET);
}

public function doLocate(){
return $this->sendCommand(self::$CMD_LOCATE);
}

/**
* Envoie une commande au module
*
* @param string $message
*/
private function sendCommand($message)
{
$result = false;
if ($this->openSocket() !== FALSE) {
if (socket_sendto($this->socket, $message, strlen($message), 0, $this->ip, self::$PORT) !== FALSE) {
$result = $this->readAcknoledge();
}
}
$this->closeSocket();
return $result;
}

/**
* Attend la confirmation de la commande
*
* @return boolean
*/
private function readAcknoledge()
{
$buf = "";
$retries = 0;
while ($retries < self::$RETRIES) {
$byteReceived = socket_recvfrom($this->socket, $buf, 2048, 0, $this->ip, self::$PORT);
if ($byteReceived > 0) {
return $buf != self::$RESPONSE_NOK ? $buf : FALSE;
}
usleep(500000);
$retries ++;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) === FALSE) {
$errorcode = socket_last_error();
$errormsg = socket_strerror($errorcode);
echo ("Couldn't create socket: [$errorcode] $errormsg \n");
return false;
}
return true;
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
On créé un fichier ''Command.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicHandler.class.php';

$esp_ip = "192.168.1.200";

$handler = new MusicHandler($esp_ip);

// Exemple de commandes //
//$result = $handler->volumeUp();
//$result = $handler->getVolume();
//$result = $handler->doReset();
//$result = $handler->setVolume(70);

$result = $handler->doLocate();

echo $result !== FALSE ? "ok : $result\n" : "nok\n";
</source>
== Partie Cliente ==
Dans la partie des imports ajoutez la ligne suivante :
<source lang="c">
#include <WiFiUDP.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// Command Server parameters //
const uint16_t CMD_PORT = 5046;
// L'instance du serveur UDP
WiFiUDP udp;
// Liste de commandes
const char CMD_VOLUME = 'V';
const char CMD_LOCATE = 'L';
const char CMD_RESET = 'R';
const char RESPONSE_NOK[] = "N";

// Localisation parameters
uint8_t ledPin = LED_BUILTIN;
const uint16_t BLINK_FREQ = 500;
const uint8_t BLINK_REP = 60;
uint8_t repetition = 0;
uint32_t timer;
bool isLocate = false;
</source>
A la fin de la fonction setup() nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur UDP
initCmdServer();
// On prépare la led de localisation
initLocateLed();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
bool readCmd() {
if (udp.parsePacket() > 0) {
uint8_t len = udp.available();
char c = udp.read();
if (len == 1) {
if (c == CMD_RESET) {
player.softReset();
sendPacket(CMD_RESET);
return true;
} else if (c == CMD_VOLUME) {
sendPacket(volume_level);
return true;
} else if (c == CMD_LOCATE) {
if (!isLocate) {
locate(true);
sendPacket(CMD_LOCATE);
return true;
}
}
} else if (len == 2) {
char value = udp.read();
if (c == CMD_VOLUME) {
if (value == '+' && volume_level != 100) {
setVolume(volume_level + 1);
} else if (value == '-' && volume_level != 0) {
setVolume(volume_level - 1);
} else {
sendNack();
return false;
}
return true;
}
} else {
if (c == CMD_VOLUME) {
char value[4] = "0";
udp.read(value, 3);
uint8_t vol = atoi(value);
if (vol >= 0 && vol <= 100) {
setVolume(vol);
return true;
}
}
}
sendNack();
return false;
}
// Check if locate needs to be done
locate(false);
}
void locate(bool blink) {
if (blink) {
// Initialisation des variables
digitalWrite(ledPin, LOW);
isLocate = true;
repetition = 0;
timer = millis();
} else if (isLocate) {
// Calcule du temps
uint32_t elapsed = millis() - timer;
if (elapsed > BLINK_FREQ) {
repetition++;
if (repetition == BLINK_REP) {
// On a atteint le nombre de clignotements
isLocate = false;
digitalWrite(ledPin, HIGH);
} else {
// On fait clignoter la led
digitalWrite(ledPin, !digitalRead(ledPin));
timer = millis();
}
}
}
}

void setVolume(uint8_t vol) {
volume_level = vol;
Serial.printf("Setting volume to %d\n", volume_level);
player.setVolume(volume_level);
sendPacket(volume_level);
}

void sendNack() {
sendPacket(RESPONSE_NOK);
}

void sendPacket(const char content) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(const char content[]) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(int content) {
char value[4];
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(itoa(content, value, 10));
udp.endPacket();
}

void initCmdServer() {
// Démarrage du serveur TCP
udp.begin(CMD_PORT);
Serial.printf("Ecoute UDP sur le port %d\n", CMD_PORT);
}

void initLocateLed() {
pinMode(ledPin, OUTPUT);
digitalWrite(ledPin, HIGH);
}
</source>
L'ESP est maintenant capable de :
* monter / baisser le volume ;
* de faire un reset du lecteur MP3 (en cas de problème)
* de faire clignoter sa led pour être localisé facilement.

= Enceinte armbian =
Même objectif mais cette fois-ci avec Rygel, un lecteur DLNA.
==Installation ==
Le système:
<pre>
# apt-get update
</pre>
Le lecteur rygel:
<pre>
# apt-get -y install rygel-playbin
</pre>
Les différents plugins. Tout d'abord, récupérer les plugins en fonctions de la distribution:
* Pour le Banana PI:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | awk -F ' - ' '{print $1}')
</pre>
* Pour le Raspberry PI:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | grep -v python | awk -F ' - ' '{print $1}')
</pre>
Ensuite on procéde à l'installation:
<pre>
# apt-get install ${plugins}
</pre>

== Création du fichier de service ==
Il suffit de créer le fichier ''/etc/systemd/system/rygel.service'':
<pre>
[Unit]
Description=Rygel service
After=network-online.target

[Service]
Type=simple
UMask=007
ExecStart=/usr/bin/rygel -g 5
Restart=on-failure

# Configures the time to wait before service is stopped forcefully.
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
On peut lancer le service et l'activer au démarrage
<pre>
# systemctl start rygel
# systemctl enable rygel
</pre>
== Désactivation des logs ==
Comme l'enceinte n'est pas à proprement parler un serveur exécutant un service critique, on peut désactiver le système de logging pour économiser la durée de vie de la carte SD:
<pre>
# systemctl stop rsyslog
# systemctl disable rsyslog
</pre>
== Ajustement du volume ==
Il faut maintenant mettre le volume au maximum coté Pi avec le mixer ALSA [https://fr.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture wikipedia] :
<pre>
# alsamixer
</pre>
[[Fichier:alsamixer armbian.png|centré]]
== Changement de la carte son par défaut ==
Une fois la carte son USB installée, il suffit d'utiliser la commande suivante pour voir son identifiant:
<pre>
# aplay -l
**** List of PLAYBACK Hardware Devices ****
card 0: sun4icodec [sun4i-codec], device 0: CDC PCM Codec-0 []
Subdevices: 1/1
Subdevice #0: subdevice #0
card 1: Device [USB Audio Device], device 0: USB Audio [USB Audio]
Subdevices: 0/1
Subdevice #0: subdevice #0
</pre>
La carte son avec l'ID ''0'' est celle intégrée au PI, celle avec l'ID ''1'' est la carte USB.
Pour dire à ALSA que c'est la carte avec l'ID ''1'' que l'on veut par défaut, il suffit de créer le fichier ''/etc/asound.conf'' avec les lignes suivantes:
<pre>
defaults.pcm.card 1
defaults.ctl.card 1
</pre>
La configuration est appliquée après un redémarrage !

== WiringPI==
===Installation===
Pour le Banana Pi M1:
<pre>
# cd /opt
# git clone https://github.com/LeMaker/WiringLMK.git
# cd WiringLMK
# chmod +x ./build
# ./build
</pre>
Pour le Raspberry Pi 2:
<pre>
# apt install -y wiringpi
</pre>

=== Utilisation===
Pour la lecture des états
<pre>
# gpio readall
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| | | 3.3v | | | 1 || 2 | | | 5v | | |
| 2 | 8 | SDA.1 | ALT5 | 0 | 3 || 4 | | | 5V | | |
| 3 | 9 | SCL.1 | ALT5 | 0 | 5 || 6 | | | 0v | | |
| 4 | 7 | GPIO. 7 | IN | 0 | 7 || 8 | 1 | ALT2 | TxD | 15 | 14 |
| | | 0v | | | 9 || 10 | 0 | IN | RxD | 16 | 15 |
| 17 | 0 | GPIO. 0 | IN | 0 | 11 || 12 | 0 | IN | GPIO. 1 | 1 | 18 |
| 27 | 2 | GPIO. 2 | IN | 0 | 13 || 14 | | | 0v | | |
| 22 | 3 | GPIO. 3 | IN | 0 | 15 || 16 | 0 | IN | GPIO. 4 | 4 | 23 |
| | | 3.3v | | | 17 || 18 | 0 | IN | GPIO. 5 | 5 | 24 |
| 10 | 12 | MOSI | ALT5 | 0 | 19 || 20 | | | 0v | | |
| 9 | 13 | MISO | ALT5 | 0 | 21 || 22 | 0 | IN | GPIO. 6 | 6 | 25 |
| 11 | 14 | SCLK | ALT5 | 0 | 23 || 24 | 0 | ALT5 | CE0 | 10 | 8 |
| | | 0v | | | 25 || 26 | 0 | ALT5 | CE1 | 11 | 7 |
| 0 | 30 | SDA.0 | IN | 1 | 27 || 28 | 1 | IN | SCL.0 | 31 | 1 |
| 5 | 21 | GPIO.21 | IN | 0 | 29 || 30 | | | 0v | | |
| 6 | 22 | GPIO.22 | ALT4 | 0 | 31 || 32 | 0 | ALT4 | GPIO.26 | 26 | 12 |
| 13 | 23 | GPIO.23 | IN | 0 | 33 || 34 | | | 0v | | |
| 19 | 24 | GPIO.24 | IN | 0 | 35 || 36 | 0 | IN | GPIO.27 | 27 | 16 |
| 26 | 25 | GPIO.25 | IN | 0 | 37 || 38 | 0 | IN | GPIO.28 | 28 | 20 |
| | | 0v | | | 39 || 40 | 0 | IN | GPIO.29 | 29 | 21 |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
</pre>
Ou d'un état:
<pre>
# gpio read 1
0
</pre>
Changement d'état:
<pre>
# gpio -1 write 8 0
</pre>

== Détection de musique ==
Il est possible de détecter si de la musique est en train d'être jouée sur le PI grâce à la commande suivante:
<pre>
# cat /proc/asound/card*/pcm*/sub*/status | grep RUNNING | wc -l
</pre>
Si cette commande renvoie ''1'' cela veut dire que ''state: RUNNING'' est présent dans un des fichiers d'une des cartes son.

Cette commande peu permettre de piloter un amplificateur au travers d'un relais piloté par une GPIO...
<source lang="php">
#!/usr/bin/php
<?php

function main($argv){
// Amp relay GPIO
$GPIO = 1;
$cmd = 'cat /proc/asound/card*/pcm*/sub*/status | grep RUNNING | wc -l';
shell_exec('gpio mode '.$GPIO.' output');
shell_exec('gpio write '.$GPIO.' 0');
while(1){
exec($cmd, $output, $ret);
if($ret==0){
echo 'gpio write '.$GPIO.' '.$output[0]."\n";
shell_exec('gpio write '.$GPIO.' '.$output[0]);
unset($output);
}
usleep(50);
}
}

main($argv);
</source>

== Ajout du bluetooth ==
=== Paramétrage de la carte===
Il faut d'abord installer blueZ:
<pre>
# apt install -y bluez bluez-tools bluealsa
</pre>
Il faut créer le fichier ''/etc/bluetooth/audio.conf'':
<pre>
[General]
Enable=Source,Sink,Media,Socket
</pre>
éditez le fichier ''/etc/bluetooth/main.conf'' pour modifier les lignes suivantes:
<pre>
...
Class = 0x00041C
...
DiscoverableTimeout = 0
...
PairableTimeout = 0
...
</pre>
Il faut ensuite redémarrer le service ''bluetooth'' pour appairer le téléphone:
<pre>
# systemctl restart bluetooth
</pre>
=== Déclaration de services===
Avant d'aller plus loin, nous allons enregistrer deux commandes en tant que service système:
* ''bluealsa -p a2dp-sink &'' : qui permet de déclarer le PI comme point de terminaison A2DP (musique);
* ''bluealsa-aplay 00:00:00:00:00:00'' : qui permet de laisser passer la musique sur la carte son par défaut.
Pour cela nous allons utiliser la même technique que pour Rygel (plus haut):
* Dans le fichier ''/etc/systemd/system/blue-a2dp.service'':
<pre>
[Unit]
Description=Alsa A2DP service
After=bluetooth.target

[Service]
ExecStart=/usr/bin/bluealsa -p a2dp-sink
Restart=on-failure
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
* Dans le fichier ''/etc/systemd/system/blue-aplay.service'':
<pre>
[Unit]
Description=Alsa Aplay authorization service
After=bluetooth.target

[Service]
ExecStart=/usr/bin/bluealsa-aplay 00:00:00:00:00:00
Restart=on-failure
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
Il ne reste plus qu'à enregistrer les services:
<pre>
# systemctl start blue-a2dp.service
# systemctl start blue-aplay.service
# systemctl enable blue-aplay.service
# systemctl enable blue-a2dp.service
</pre>

=== Appairage ===
Il faut lancer l'utilitaire ''bluetoothctl'':
<pre>
# bluetoothctl
Agent registered
[bluetooth]#
[CHG] Device 0C:2C:54:1B:A3:A9 Connected: yes
[tala_phone]#
</pre>

Iot speaker

2019-07-19T17:42:40Z

Tala : /* Installation */

=Projet=
{|class="wikitable" width="100%"
|-valign=top
! Objectif !! Les acteurs !! Compétences !! Matériel
|-valign=top
||
Construire des enceintes sans-fils (sauf le courant) actives connectées capables de travailler en "groupe"
||
*[[User:Tala | Tala]]
*[[User:Nigdor |Nigdor]]
*[[User:Prandar |Prandar]]
||
*électronique
*C++ (microcontrôleur)
||
* microcontrôleur (esp8266)
* amplificateur audio (XPT8871, PAM8403, ...)
* décodeur MP3 (VS1053B)
* potentiomètre digital (X9C103S)
|}

= Choix de l'amplificateur =
A faire:
*Expliquer la différence entre classe AB et D (qualité sonore vs. éco énergie)
*Faire un tableau récapitulatif des caractéristiques des amplis:
** mono / stéréo / les deux
** tension de fonctionnement / consommation (5v, 12v, 24v, etc...)
** puissance (5w, 20w, 30w, etc...)
** impédance de sortie (2 x 4Ω, 1 x 8Ω, etc...)
** réponse fréquentielle ;
** résistance aux courts-circuits ;
** bruit pop (quand pas de musique);
** besoin d'un dissipateur ou non (effet joule à prévoir...)
** lien vers la documentation si besoin d'info(eg. pour le [https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932])
** le plus important : le ressenti !
==Classe AB==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
TDA7297
|align=center|
[[Fichier:TDA7297.png|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 15W
|align=center|
2A (peak)
|align=center|
6 - 18 V
|align=center|
OUI
|align=center|
Avec µControlleur<br>(p. 3/4)
|align=center|
Obligatoire
|align=center|
[http://www.st.com/content/ccc/resource/technical/document/datasheet/a3/eb/9b/59/dd/26/4a/27/CD00001048.pdf/files/CD00001048.pdf/jcr:content/translations/en.CD00001048.pdf TDA7297]
|align=left|
Super amplification sans distorsion !
<br>
Forte dissipation thermique à pleine puissance :
* 33W d'après la doc;
* vraiment très (trop) fort !
|}
</div>

==Classe D==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
XH-M531 (YDA138)
|align=center|
[[Fichier:XH-M531.jpg|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 10 W<br>
2 x 20 W
|align=center|
8 Ω<br>
4 Ω
|align=center|
12 - 15V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.ksp-electronics.com/product_files/8eeedc66ea8fbcdf2e74294037c2f389 YDA138]
|align=center|
|-valign="top"
|align=center|
PAM8403
|align=center|
[[Fichier:PAM8403.jpg|centré|100px]]
|align=center|
Stéréo
|align=center|
3W(*2 ?)
|align=center|
4 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
Reduit mais présent
|align=center|
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8403.pdf PAM8403]
|align=center|
|-valign="top"
|align=center|
PAM8610
|align=center|
[[Fichier:PAM8610.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 10 W
|align=center|
8 Ω
|align=center|
7 - 15 V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8610.pdf PAM8610]
|align=center|
|-valign="top"
|align=center|
XPT8871
|align=center|
[[Fichier:XPT8871.jpg|centré|120px]]
|align=center|
Mono
|align=center|
3.5w
<br>
5w
|align=center|
3 Ω
<br>
2 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[[Media:XPT8871.pdf|XPT8871]]
|align=left|
*Bien pour la voix, pas top pour la musique
|-valign="top"
|align=center|
TDA8932
|align=center|
[[Fichier:TDA8932.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2*15W
|align=center|
4 Ω
|align=center|
Entre 10 V et 36 V (Rechercher quel est le plus optimal)
|align=center|
OUI
|align=center|
NON
|align=center|

|align=center|
[https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932]
|align=center|
|-valign="top"
|align=center|
TPA3110
|align=center|
[[Fichier:TPA3110.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
15W/ch
|align=center|
8 Ω
|align=center|
16 V
|align=center|
OUI
|align=center|
NON
|align=center|
OUI
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3110d2.pdf TPA3110]
|align=left|
*Amplification moyenne
*Basses creuses
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3116
|align=center|
[[Fichier:TPA3116.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 50W<br>
2 x 15W
|align=center|
4 Ω<br>
8 Ω
|align=center|
21 V<br>
15 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI<br>
NON
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3116d2.pdf TPA3116]
|align=left|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3118
|align=center|
[[Fichier:TPA3118.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 30W
|align=center|
8 Ω
|align=center|
12 - 24 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI
|align=left|
[http://www.ti.com/lit/ds/symlink/tpa3118d2.pdf TPA3118]
|align=center|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|}
</div>

= Potentiomètre digital =
A faire

= Décodeur MP3 =
==Présentation==
Le décodeur MP3 choisi est le VS1053

[[Fichier:vs1053_board.jpg|centré|200px]]

Ce décodeur offre une interface SPI et permet de lire ainsi que d'enregistrer des fichiers aux formats :
* lecture :
**MP3 ;
**Ogg Vorbis (libre de droit) ;
**PCM;
**WAV;
* enregistrement :
**Ogg Vorbis(libre de droit) ;

==Documentation technique==
Voici la [[:Media:vs1053_doc.pdf|documentation du VS1053]], pour ceux qui voudraient écrire une librairie C++ !

== Schéma ==
Les tests ont été réalisés avec un WemOS D1 mini (ESP8266) :
<div align="center">
{|class="wikitable" width="85%"
! ESP8266 !! VS1053 !! Connections
|-valign=top
||
[[Fichier:wemos_D1_R2_mini_diagram.png|centré|470px]]
||
[[Fichier:vs1053_board_diagram.png|centré|300px]]
|align="center"|
{|class="wikitable"
! ESP8266 !! VS1053
|-
|align="center"| D0
|align="center"| XDCS
|-
|align="center"| D1
|align="center"| XoS (Cable Select)
|-
|align="center"| D3
|align="center"| DREQ
|-
|align="center"| D5
|align="center"| SCK (Serial ClocK)
|-
|align="center"| D6
|align="center"| MISO (Master In Slave Out)
|-
|align="center"| D7
|align="center"| MOSI (Master Out Slave In)
|-
|align="center"| RST
|align="center"| XRST
|-
|align="center"| 5V
|align="center"| 5V
|-
|align="center"| G
|align="center"| DGND
|}
|}
</div>
Vous devriez avoir quelque chose comme ça :

[[Fichier:wemos_D1_vs1053_diagram.jpg|centré|400px]]

== Programmation ==
Tout d'abord un grand merci à [https://github.com/baldram/ESP_VS1053_Library ''baldram''] pour sa [[Media:ESP_VS1053_Library.zip|librairie]] que nous allons utiliser !

Le plus simple est de regarder l'exemple ''SimpleMP3Player'' fourni avec la librairie :
<source lang="c">
// La fameuse librairie de baldram
#include <VS1053.h>
// Un MP3 au format binaire dans un tableau (le fichier est livré avec la librairie)
#include <helloMp3.h>
// Définition des port SPI utilisé (ici pour l'ESP8266)
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
// Définition du volume
#define VOLUME 80 // volume level 0-100
// Création de l'objet VS1053
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);

void setup () {
// Démarrage du SPI
SPI.begin();
// démarrage du VS1053
player.begin();
// Ligne nécessaire pour certain lecteur
player.switchToMp3Mode();
player.setVolume(VOLUME);
}

void loop() {
// On joue le MP3 dans le tableau
player.playChunk(helloMp3, sizeof(helloMp3));
// On attend 3 secondes
delay(3000);
}
</source>
Pour que cet exemple fonctionne, il faut soit copier le contenu de ''HelloMp3.h'' dans le fichier exemple, soit copier le fichier dans le répertoire de la librairie dans votre dossier ''Arduino''.

Une fois la compilation terminée, vous devriez entendre ''du bruit'' sortir du VS1053 !

= Flux musical =
La communication se fera en générant un flux entre le programme (PC) et l'enceinte (ESP8266). Ce flux, pour des raisons de simplicité, se fera en TCP car ce protocole gère les retransmissions, les tampons d'entrée / sortie, etc...

A terme, une application temps réel comme la musique mériterait de passer sur de l'UDP. Surtout que, si l'on souhaite utiliser du [https://www.tala-informatique.fr/wiki/index.php/Esp8266_udp_server multicast], pour parler à un groupe d'enceintes, on ne peut le faire qu'en UDP !
== Envoi : serveur en PHP ==
La partie serveur prend un fichier, ici un MP3, lit un morceau du fichier et l'envoi à l'enceinte à travers une socket TCP. Deux paramètres sont à prendre en compte :
*le temps d'attente entre chaque envoi;
*la taille d'un morceau;
Ces paramètres nécessiteront certainement un temps d'ajustement qui sera en fonction de la latence, la congestion du réseau, les capacités des puces impliquées (ici l'ESP8266), etc...
{|style="width:650px" align="center"
|
[[Fichier:warning-icon.png|centré|60px]]
|valign="top" align="justify"|
Les extraits de code qui vont suivre respectent vaguement les préceptes, au combien importants, de la programmation orientée objet et sont fournis à titre indicatif dans l'unique but de démontrer la faisabilité d'un tel projet ! Voici [[:Media:Iot_Speaker.zip | l'archive]] qui contient le code exposé ci-dessous.
|}
=== MusicSender ===
Voici le contenu du fichier ''MusicSender.class.php'' :
<source lang="php">
<?php

class MusicSender
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5045;

// Le temps d'attente en microsecondes entre chaque paquets
private static $SLEEP_INTERVAL = 2500;

// La taille de chacun des paquets
private static $CHUNK_BUFFER = 32768;

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Envoie le MP3 à l'enceinte
*
* @param string $mp3File
* @return boolean
*/
public function play($mp3File)
{
if (is_file($mp3File)) {
// Ouverture du fichier en lecture binaire
$file = fopen($mp3File, 'rb');
if ($file === FALSE) {
echo "Fail reading file " . $file . "\n";
return FALSE;
}
// Ouverture de la socket
$socket = $this->openSocket();
// Tant qu'on est pas à la fin du fichier
while (! feof($file)) {
// Envoie d'un "morceau" de taille CHUNK_BUFFER à l'enceinte
if (@socket_write($this->socket, fread($file, self::$CHUNK_BUFFER), self::$CHUNK_BUFFER) === FALSE) {
// Problème de socket (fermeture, déconnexion, etc...)
return FALSE;
}
usleep(self::$SLEEP_INTERVAL);
}
// Fermeture de la socket
$this->closeSocket();
// Fermeture du fichier
fclose($file);
return TRUE;
}
echo $file." does not exists !\n";
return FALSE;
}

/**
* Lit tous les mp3 présents dans le dossier
*
* @param string $dir
*/
public function readFolder($dir)
{
if (is_dir($dir)) {
// On récupére les fichiers sans les 2 premiers '.' et '..'
$files = array_slice(scandir($dir), 2);
foreach ($files as $file) {
// On créé le chemin absolu
$mp3File = $dir . DIRECTORY_SEPARATOR . $file;
// On test l'extension
if (pathinfo($file)["extension"] == "mp3") {
$this->play($mp3File);
}
}
return true;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) == FALSE) {
echo "socket_create_listen() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
if (socket_connect($this->socket, $this->ip, self::$PORT) == FALSE) {
echo "socket_bind() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
=== Launch.php ===
On créé un fichier ''Launch.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicSender.class.php';

$esp_ip = "192.168.1.200";

$dir = "!!chemin_vers_des_fichiers_mp3!!";

$sender = new MusicSender($esp_ip);

$sender->readFolder($dir);
</source>

== Réception : ESP8266 ==
{|style="width:650px" align="center"
|
[[Fichier:Warning manual.jpg|centré|300px]]
|valign="top" align="justify"|
Soyez sûr de comprendre la section sur [https://www.tala-informatique.fr/wiki/index.php/Arduino_sketch_writing| comment écrire un sketch] avant de poursuivre. Le code ci-dessous fait référence à des parties bien spécifiques, détaillées et expliquées dans la section suscitée.
|}
=== Partie WiFi ===
La première étape consiste à raccorder notre ''ESP'' au réseau WiFi !
<source lang="c">
#include <ESP8266WiFi.h>
#include <WiFiClient.h>

// WiFi Parameters //
const char ssid[] = "cfcasa";
const char password[] = "***********";
IPAddress ip(192, 168, 1, 200);
IPAddress gw(192, 168, 1, 254);
IPAddress mask(255, 255, 252, 0);

void setup() {
// on démarre le port série
Serial.begin(115200);
// On attend "un peu" que le buffer soit prêt
delay(10);
// On démarre le WiFi
initWiFi();
}

void loop() {
}

void initWiFi() {
// On efface la configuration précédente
WiFi.disconnect(true);
Serial.printf("\nConnexion a %s", ssid);
// Initialisation de la connection
WiFi.config(ip, gw, mask, gw);
WiFi.begin(ssid, password);
// Test pour déterminer quand la connection est prete
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(".");
}
// Affichage des informations
Serial.printf(" connecté\nAdresse IP: %s\n", WiFi.localIP().toString().c_str());
}
</source>
=== Lecteur MP3 ===
Vient ensuite la partie du lecteur MP3. Dans la partie des imports, ajoutez la ligne suivante :
<source lang="c">
#include <VS1053.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Parameters //
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
#define VOLUME 70 // volume level 0-100
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);
uint8_t volume_level = VOLUME;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le shield MP3
initMP3();
</source>
A la suite, on insère la fonction suivante :
<source lang="c">
void initMP3() {
SPI.begin();
// Démarrage du lecteur MP3
player.begin();
player.switchToMp3Mode();
player.setVolume(volume_level);
}
</source>
=== Récupération du stream MP3 ===
On va maintenant récupérer le flux envoyé depuis le serveur. Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Server parameters //
const uint16_t MP3_PORT = 5045;
WiFiServer server(MP3_PORT);
const uint16_t BUFFER_SIZE = 16384;
//const uint16_t BUFFER_SIZE = 32768;
byte buffer[BUFFER_SIZE + 1];
uint16_t byteRead = 0;
bool isBufferReady = false;
WiFiClient client;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur TCP
initMp3Server();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
void initMp3Server() {
// Démarrage du serveur TCP
server.begin();
Serial.printf("Ecoute TCP sur le port %d\n", MP3_PORT);
}

void readMp3() {
// Un client est connecté
if (client) {
// Si le client est toujours connecté...
if (client.connected()) {
// Tant que l'on reçoit de la musique
while (client.available() > 0) {
// On rempli le buffer avec le contenu du paquet TCP
buffer[byteRead++] = client.read();
// Si le buffer est plein
if (byteRead == BUFFER_SIZE) {
// On previent que le buffer est plein
isBufferReady = true;
// On sort de la boucle
break;
}
}
// Si le buffer est plein
if (isBufferReady) {
// On envoi tout au lecteur MP3
player.playChunk(buffer, byteRead);
// On RAZ le compteur de bytes
byteRead = 0;
}
} else {
// Si le client est déconneté
client = server.available();
// On prévient que le buffer est vide
isBufferReady = false;
// On RAZ le compteur de bytes
byteRead = 0;
Serial.println(F("Client disconnected"));
}
} else {
// On test la présence d'un client
client = server.available();
if (client) {
// Un client est connecté !
Serial.println(F("New client !"));
}
}
}
</source>
Enfin, on ajoute le ligne suivante dans la fonction ''loop()'' :
<source lang="c">
readMp3();
</source>
A ce stade, l'ESP devrait être capable de récupérer le flux et de le jouer !

= Envoi de commandes =
Envoyer de la musique c'est bien, pouvoir régler le volume c'est encore mieux !

La façon la plus simple d'adresser le problème c'est d'utiliser un autre port et, comme les messages sont petits, d'utiliser UDP.
== Partie Serveur ==
Dans la même veine, voici la classe qui permet d'envoyer les commandes :
<source lang="php">
<?php

class MusicHandler
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5046;

// Le port de l'enceinte connectée
private static $RETRIES = 3;

// Liste de commandes
private static $CMD_VOLUME = 'V';

private static $CMD_LOCATE = 'L';

private static $CMD_RESET = 'R';

private static $RESPONSE_NOK = 'N';

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Augmente le volume d'un incrément
*
* @return boolean
*/
public function volumeUp()
{
return $this->sendCommand(self::$CMD_VOLUME . "+");
}

/**
* Baisse le volume d'un incrément
*
* @return boolean
*/
public function volumeDown()
{
return $this->sendCommand(self::$CMD_VOLUME . "-");
}

/**
*
* @return boolean
*/
public function setVolume($volume)
{
if ($volume < 0 || $volume > 100) {
return false;
}
return $this->sendCommand(self::$CMD_VOLUME . $volume);
}

public function getVolume(){
return $this->sendCommand(self::$CMD_VOLUME);
}

/**
*
* @return boolean
*/
public function doReset()
{
return $this->sendCommand(self::$CMD_RESET);
}

public function doLocate(){
return $this->sendCommand(self::$CMD_LOCATE);
}

/**
* Envoie une commande au module
*
* @param string $message
*/
private function sendCommand($message)
{
$result = false;
if ($this->openSocket() !== FALSE) {
if (socket_sendto($this->socket, $message, strlen($message), 0, $this->ip, self::$PORT) !== FALSE) {
$result = $this->readAcknoledge();
}
}
$this->closeSocket();
return $result;
}

/**
* Attend la confirmation de la commande
*
* @return boolean
*/
private function readAcknoledge()
{
$buf = "";
$retries = 0;
while ($retries < self::$RETRIES) {
$byteReceived = socket_recvfrom($this->socket, $buf, 2048, 0, $this->ip, self::$PORT);
if ($byteReceived > 0) {
return $buf != self::$RESPONSE_NOK ? $buf : FALSE;
}
usleep(500000);
$retries ++;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) === FALSE) {
$errorcode = socket_last_error();
$errormsg = socket_strerror($errorcode);
echo ("Couldn't create socket: [$errorcode] $errormsg \n");
return false;
}
return true;
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
On créé un fichier ''Command.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicHandler.class.php';

$esp_ip = "192.168.1.200";

$handler = new MusicHandler($esp_ip);

// Exemple de commandes //
//$result = $handler->volumeUp();
//$result = $handler->getVolume();
//$result = $handler->doReset();
//$result = $handler->setVolume(70);

$result = $handler->doLocate();

echo $result !== FALSE ? "ok : $result\n" : "nok\n";
</source>
== Partie Cliente ==
Dans la partie des imports ajoutez la ligne suivante :
<source lang="c">
#include <WiFiUDP.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// Command Server parameters //
const uint16_t CMD_PORT = 5046;
// L'instance du serveur UDP
WiFiUDP udp;
// Liste de commandes
const char CMD_VOLUME = 'V';
const char CMD_LOCATE = 'L';
const char CMD_RESET = 'R';
const char RESPONSE_NOK[] = "N";

// Localisation parameters
uint8_t ledPin = LED_BUILTIN;
const uint16_t BLINK_FREQ = 500;
const uint8_t BLINK_REP = 60;
uint8_t repetition = 0;
uint32_t timer;
bool isLocate = false;
</source>
A la fin de la fonction setup() nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur UDP
initCmdServer();
// On prépare la led de localisation
initLocateLed();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
bool readCmd() {
if (udp.parsePacket() > 0) {
uint8_t len = udp.available();
char c = udp.read();
if (len == 1) {
if (c == CMD_RESET) {
player.softReset();
sendPacket(CMD_RESET);
return true;
} else if (c == CMD_VOLUME) {
sendPacket(volume_level);
return true;
} else if (c == CMD_LOCATE) {
if (!isLocate) {
locate(true);
sendPacket(CMD_LOCATE);
return true;
}
}
} else if (len == 2) {
char value = udp.read();
if (c == CMD_VOLUME) {
if (value == '+' && volume_level != 100) {
setVolume(volume_level + 1);
} else if (value == '-' && volume_level != 0) {
setVolume(volume_level - 1);
} else {
sendNack();
return false;
}
return true;
}
} else {
if (c == CMD_VOLUME) {
char value[4] = "0";
udp.read(value, 3);
uint8_t vol = atoi(value);
if (vol >= 0 && vol <= 100) {
setVolume(vol);
return true;
}
}
}
sendNack();
return false;
}
// Check if locate needs to be done
locate(false);
}
void locate(bool blink) {
if (blink) {
// Initialisation des variables
digitalWrite(ledPin, LOW);
isLocate = true;
repetition = 0;
timer = millis();
} else if (isLocate) {
// Calcule du temps
uint32_t elapsed = millis() - timer;
if (elapsed > BLINK_FREQ) {
repetition++;
if (repetition == BLINK_REP) {
// On a atteint le nombre de clignotements
isLocate = false;
digitalWrite(ledPin, HIGH);
} else {
// On fait clignoter la led
digitalWrite(ledPin, !digitalRead(ledPin));
timer = millis();
}
}
}
}

void setVolume(uint8_t vol) {
volume_level = vol;
Serial.printf("Setting volume to %d\n", volume_level);
player.setVolume(volume_level);
sendPacket(volume_level);
}

void sendNack() {
sendPacket(RESPONSE_NOK);
}

void sendPacket(const char content) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(const char content[]) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(int content) {
char value[4];
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(itoa(content, value, 10));
udp.endPacket();
}

void initCmdServer() {
// Démarrage du serveur TCP
udp.begin(CMD_PORT);
Serial.printf("Ecoute UDP sur le port %d\n", CMD_PORT);
}

void initLocateLed() {
pinMode(ledPin, OUTPUT);
digitalWrite(ledPin, HIGH);
}
</source>
L'ESP est maintenant capable de :
* monter / baisser le volume ;
* de faire un reset du lecteur MP3 (en cas de problème)
* de faire clignoter sa led pour être localisé facilement.

= Enceinte armbian =
Même objectif mais cette fois-ci avec Rygel, un lecteur DLNA.
==Installation ==
Le système:
<pre>
# apt-get update
</pre>
Le lecteur rygel:
<pre>
# apt-get -y install rygel-playbin
</pre>
Les différents plugins. Tout d'abord, récupérer les plugins en fonctions de la distribution:
* Pour le Banana PI:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | awk -F ' - ' '{print $1}')
</pre>
* Pour le Raspberry PI:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | grep -v python | awk -F ' - ' '{print $1}')
</pre>
Ensuite on procéde à l'installation:
<pre>
# apt-get install ${plugins}
</pre>

== Création du fichier de service ==
Il suffit de créer le fichier ''/etc/systemd/system/rygel.service'':
<pre>
[Unit]
Description=Rygel service
After=network-online.target

[Service]
Type=simple
UMask=007
ExecStart=/usr/bin/rygel -g 5
Restart=on-failure

# Configures the time to wait before service is stopped forcefully.
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
On peut lancer le service et l'activer au démarrage
<pre>
# systemctl start rygel
# systemctl enable rygel
</pre>
== Désactivation des logs ==
Comme l'enceinte n'est pas à proprement parler un serveur exécutant un service critique, on peut désactiver le système de logging pour économiser la durée de vie de la carte SD:
<pre>
# systemctl stop rsyslog
# systemctl disable rsyslog
</pre>
== Ajustement du volume ==
Il faut maintenant mettre le volume au maximum coté Pi avec le mixer ALSA [https://fr.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture wikipedia] :
<pre>
# alsamixer
</pre>
[[Fichier:alsamixer armbian.png|centré]]
== Changement de la carte son par défaut ==
Une fois la carte son USB installée, il suffit d'utiliser la commande suivante pour voir son identifiant:
<pre>
# aplay -l
**** List of PLAYBACK Hardware Devices ****
card 0: sun4icodec [sun4i-codec], device 0: CDC PCM Codec-0 []
Subdevices: 1/1
Subdevice #0: subdevice #0
card 1: Device [USB Audio Device], device 0: USB Audio [USB Audio]
Subdevices: 0/1
Subdevice #0: subdevice #0
</pre>
La carte son avec l'ID ''0'' est celle intégrée au PI, celle avec l'ID ''1'' est la carte USB.
Pour dire à ALSA que c'est la carte avec l'ID ''1'' que l'on veut par défaut, il suffit de créer le fichier ''/etc/asound.conf'' avec les lignes suivantes:
<pre>
defaults.pcm.card 1
defaults.ctl.card 1
</pre>
La configuration est appliquée après un redémarrage !

== WiringPI==
===Installation===
Pour le Banana Pi M1:
<pre>
# cd /opt
# git clone https://github.com/LeMaker/WiringLMK.git
# cd WiringLMK
# chmod +x ./build
# ./build
</pre>
Pour le Raspberry Pi 2:
<pre>
# apt install -y wiringpi
</pre>

=== Utilisation===
Pour la lecture des états
<pre>
# gpio readall
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| | | 3.3v | | | 1 || 2 | | | 5v | | |
| 2 | 8 | SDA.1 | ALT5 | 0 | 3 || 4 | | | 5V | | |
| 3 | 9 | SCL.1 | ALT5 | 0 | 5 || 6 | | | 0v | | |
| 4 | 7 | GPIO. 7 | IN | 0 | 7 || 8 | 1 | ALT2 | TxD | 15 | 14 |
| | | 0v | | | 9 || 10 | 0 | IN | RxD | 16 | 15 |
| 17 | 0 | GPIO. 0 | IN | 0 | 11 || 12 | 0 | IN | GPIO. 1 | 1 | 18 |
| 27 | 2 | GPIO. 2 | IN | 0 | 13 || 14 | | | 0v | | |
| 22 | 3 | GPIO. 3 | IN | 0 | 15 || 16 | 0 | IN | GPIO. 4 | 4 | 23 |
| | | 3.3v | | | 17 || 18 | 0 | IN | GPIO. 5 | 5 | 24 |
| 10 | 12 | MOSI | ALT5 | 0 | 19 || 20 | | | 0v | | |
| 9 | 13 | MISO | ALT5 | 0 | 21 || 22 | 0 | IN | GPIO. 6 | 6 | 25 |
| 11 | 14 | SCLK | ALT5 | 0 | 23 || 24 | 0 | ALT5 | CE0 | 10 | 8 |
| | | 0v | | | 25 || 26 | 0 | ALT5 | CE1 | 11 | 7 |
| 0 | 30 | SDA.0 | IN | 1 | 27 || 28 | 1 | IN | SCL.0 | 31 | 1 |
| 5 | 21 | GPIO.21 | IN | 0 | 29 || 30 | | | 0v | | |
| 6 | 22 | GPIO.22 | ALT4 | 0 | 31 || 32 | 0 | ALT4 | GPIO.26 | 26 | 12 |
| 13 | 23 | GPIO.23 | IN | 0 | 33 || 34 | | | 0v | | |
| 19 | 24 | GPIO.24 | IN | 0 | 35 || 36 | 0 | IN | GPIO.27 | 27 | 16 |
| 26 | 25 | GPIO.25 | IN | 0 | 37 || 38 | 0 | IN | GPIO.28 | 28 | 20 |
| | | 0v | | | 39 || 40 | 0 | IN | GPIO.29 | 29 | 21 |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
</pre>
Ou d'un état:
<pre>
# gpio read 1
0
</pre>
Changement d'état:
<pre>
# gpio -1 write 8 0
</pre>

== Détection de musique ==
Il est possible de détecter si de la musique est en train d'être jouée sur le PI grâce à la commande suivante:
<pre>
# cat /proc/asound/card*/pcm*/sub*/status | grep RUNNING | wc -l
</pre>
Si cette commande renvoie ''1'' cela veut dire que ''state: RUNNING'' est présent dans un des fichiers d'une des cartes son.

Cette commande peu permettre de piloter un amplificateur au travers d'un relais piloté par une GPIO...

== Ajout du bluetooth ==
=== Paramétrage de la carte===
Il faut d'abord installer blueZ:
<pre>
# apt install -y bluez bluez-tools bluealsa
</pre>
Il faut créer le fichier ''/etc/bluetooth/audio.conf'':
<pre>
[General]
Enable=Source,Sink,Media,Socket
</pre>
éditez le fichier ''/etc/bluetooth/main.conf'' pour modifier les lignes suivantes:
<pre>
...
Class = 0x00041C
...
DiscoverableTimeout = 0
...
PairableTimeout = 0
...
</pre>
Il faut ensuite redémarrer le service ''bluetooth'' pour appairer le téléphone:
<pre>
# systemctl restart bluetooth
</pre>
=== Déclaration de services===
Avant d'aller plus loin, nous allons enregistrer deux commandes en tant que service système:
* ''bluealsa -p a2dp-sink &'' : qui permet de déclarer le PI comme point de terminaison A2DP (musique);
* ''bluealsa-aplay 00:00:00:00:00:00'' : qui permet de laisser passer la musique sur la carte son par défaut.
Pour cela nous allons utiliser la même technique que pour Rygel (plus haut):
* Dans le fichier ''/etc/systemd/system/blue-a2dp.service'':
<pre>
[Unit]
Description=Alsa A2DP service
After=bluetooth.target

[Service]
ExecStart=/usr/bin/bluealsa -p a2dp-sink
Restart=on-failure
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
* Dans le fichier ''/etc/systemd/system/blue-aplay.service'':
<pre>
[Unit]
Description=Alsa Aplay authorization service
After=bluetooth.target

[Service]
ExecStart=/usr/bin/bluealsa-aplay 00:00:00:00:00:00
Restart=on-failure
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
Il ne reste plus qu'à enregistrer les services:
<pre>
# systemctl start blue-a2dp.service
# systemctl start blue-aplay.service
# systemctl enable blue-aplay.service
# systemctl enable blue-a2dp.service
</pre>

=== Appairage ===
Il faut lancer l'utilitaire ''bluetoothctl'':
<pre>
# bluetoothctl
Agent registered
[bluetooth]#
[CHG] Device 0C:2C:54:1B:A3:A9 Connected: yes
[tala_phone]#
</pre>

Iot speaker

2019-07-19T17:36:56Z

Tala : /* Déclaration de services */

=Projet=
{|class="wikitable" width="100%"
|-valign=top
! Objectif !! Les acteurs !! Compétences !! Matériel
|-valign=top
||
Construire des enceintes sans-fils (sauf le courant) actives connectées capables de travailler en "groupe"
||
*[[User:Tala | Tala]]
*[[User:Nigdor |Nigdor]]
*[[User:Prandar |Prandar]]
||
*électronique
*C++ (microcontrôleur)
||
* microcontrôleur (esp8266)
* amplificateur audio (XPT8871, PAM8403, ...)
* décodeur MP3 (VS1053B)
* potentiomètre digital (X9C103S)
|}

= Choix de l'amplificateur =
A faire:
*Expliquer la différence entre classe AB et D (qualité sonore vs. éco énergie)
*Faire un tableau récapitulatif des caractéristiques des amplis:
** mono / stéréo / les deux
** tension de fonctionnement / consommation (5v, 12v, 24v, etc...)
** puissance (5w, 20w, 30w, etc...)
** impédance de sortie (2 x 4Ω, 1 x 8Ω, etc...)
** réponse fréquentielle ;
** résistance aux courts-circuits ;
** bruit pop (quand pas de musique);
** besoin d'un dissipateur ou non (effet joule à prévoir...)
** lien vers la documentation si besoin d'info(eg. pour le [https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932])
** le plus important : le ressenti !
==Classe AB==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
TDA7297
|align=center|
[[Fichier:TDA7297.png|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 15W
|align=center|
2A (peak)
|align=center|
6 - 18 V
|align=center|
OUI
|align=center|
Avec µControlleur<br>(p. 3/4)
|align=center|
Obligatoire
|align=center|
[http://www.st.com/content/ccc/resource/technical/document/datasheet/a3/eb/9b/59/dd/26/4a/27/CD00001048.pdf/files/CD00001048.pdf/jcr:content/translations/en.CD00001048.pdf TDA7297]
|align=left|
Super amplification sans distorsion !
<br>
Forte dissipation thermique à pleine puissance :
* 33W d'après la doc;
* vraiment très (trop) fort !
|}
</div>

==Classe D==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
XH-M531 (YDA138)
|align=center|
[[Fichier:XH-M531.jpg|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 10 W<br>
2 x 20 W
|align=center|
8 Ω<br>
4 Ω
|align=center|
12 - 15V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.ksp-electronics.com/product_files/8eeedc66ea8fbcdf2e74294037c2f389 YDA138]
|align=center|
|-valign="top"
|align=center|
PAM8403
|align=center|
[[Fichier:PAM8403.jpg|centré|100px]]
|align=center|
Stéréo
|align=center|
3W(*2 ?)
|align=center|
4 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
Reduit mais présent
|align=center|
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8403.pdf PAM8403]
|align=center|
|-valign="top"
|align=center|
PAM8610
|align=center|
[[Fichier:PAM8610.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 10 W
|align=center|
8 Ω
|align=center|
7 - 15 V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8610.pdf PAM8610]
|align=center|
|-valign="top"
|align=center|
XPT8871
|align=center|
[[Fichier:XPT8871.jpg|centré|120px]]
|align=center|
Mono
|align=center|
3.5w
<br>
5w
|align=center|
3 Ω
<br>
2 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[[Media:XPT8871.pdf|XPT8871]]
|align=left|
*Bien pour la voix, pas top pour la musique
|-valign="top"
|align=center|
TDA8932
|align=center|
[[Fichier:TDA8932.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2*15W
|align=center|
4 Ω
|align=center|
Entre 10 V et 36 V (Rechercher quel est le plus optimal)
|align=center|
OUI
|align=center|
NON
|align=center|

|align=center|
[https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932]
|align=center|
|-valign="top"
|align=center|
TPA3110
|align=center|
[[Fichier:TPA3110.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
15W/ch
|align=center|
8 Ω
|align=center|
16 V
|align=center|
OUI
|align=center|
NON
|align=center|
OUI
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3110d2.pdf TPA3110]
|align=left|
*Amplification moyenne
*Basses creuses
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3116
|align=center|
[[Fichier:TPA3116.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 50W<br>
2 x 15W
|align=center|
4 Ω<br>
8 Ω
|align=center|
21 V<br>
15 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI<br>
NON
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3116d2.pdf TPA3116]
|align=left|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3118
|align=center|
[[Fichier:TPA3118.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 30W
|align=center|
8 Ω
|align=center|
12 - 24 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI
|align=left|
[http://www.ti.com/lit/ds/symlink/tpa3118d2.pdf TPA3118]
|align=center|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|}
</div>

= Potentiomètre digital =
A faire

= Décodeur MP3 =
==Présentation==
Le décodeur MP3 choisi est le VS1053

[[Fichier:vs1053_board.jpg|centré|200px]]

Ce décodeur offre une interface SPI et permet de lire ainsi que d'enregistrer des fichiers aux formats :
* lecture :
**MP3 ;
**Ogg Vorbis (libre de droit) ;
**PCM;
**WAV;
* enregistrement :
**Ogg Vorbis(libre de droit) ;

==Documentation technique==
Voici la [[:Media:vs1053_doc.pdf|documentation du VS1053]], pour ceux qui voudraient écrire une librairie C++ !

== Schéma ==
Les tests ont été réalisés avec un WemOS D1 mini (ESP8266) :
<div align="center">
{|class="wikitable" width="85%"
! ESP8266 !! VS1053 !! Connections
|-valign=top
||
[[Fichier:wemos_D1_R2_mini_diagram.png|centré|470px]]
||
[[Fichier:vs1053_board_diagram.png|centré|300px]]
|align="center"|
{|class="wikitable"
! ESP8266 !! VS1053
|-
|align="center"| D0
|align="center"| XDCS
|-
|align="center"| D1
|align="center"| XoS (Cable Select)
|-
|align="center"| D3
|align="center"| DREQ
|-
|align="center"| D5
|align="center"| SCK (Serial ClocK)
|-
|align="center"| D6
|align="center"| MISO (Master In Slave Out)
|-
|align="center"| D7
|align="center"| MOSI (Master Out Slave In)
|-
|align="center"| RST
|align="center"| XRST
|-
|align="center"| 5V
|align="center"| 5V
|-
|align="center"| G
|align="center"| DGND
|}
|}
</div>
Vous devriez avoir quelque chose comme ça :

[[Fichier:wemos_D1_vs1053_diagram.jpg|centré|400px]]

== Programmation ==
Tout d'abord un grand merci à [https://github.com/baldram/ESP_VS1053_Library ''baldram''] pour sa [[Media:ESP_VS1053_Library.zip|librairie]] que nous allons utiliser !

Le plus simple est de regarder l'exemple ''SimpleMP3Player'' fourni avec la librairie :
<source lang="c">
// La fameuse librairie de baldram
#include <VS1053.h>
// Un MP3 au format binaire dans un tableau (le fichier est livré avec la librairie)
#include <helloMp3.h>
// Définition des port SPI utilisé (ici pour l'ESP8266)
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
// Définition du volume
#define VOLUME 80 // volume level 0-100
// Création de l'objet VS1053
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);

void setup () {
// Démarrage du SPI
SPI.begin();
// démarrage du VS1053
player.begin();
// Ligne nécessaire pour certain lecteur
player.switchToMp3Mode();
player.setVolume(VOLUME);
}

void loop() {
// On joue le MP3 dans le tableau
player.playChunk(helloMp3, sizeof(helloMp3));
// On attend 3 secondes
delay(3000);
}
</source>
Pour que cet exemple fonctionne, il faut soit copier le contenu de ''HelloMp3.h'' dans le fichier exemple, soit copier le fichier dans le répertoire de la librairie dans votre dossier ''Arduino''.

Une fois la compilation terminée, vous devriez entendre ''du bruit'' sortir du VS1053 !

= Flux musical =
La communication se fera en générant un flux entre le programme (PC) et l'enceinte (ESP8266). Ce flux, pour des raisons de simplicité, se fera en TCP car ce protocole gère les retransmissions, les tampons d'entrée / sortie, etc...

A terme, une application temps réel comme la musique mériterait de passer sur de l'UDP. Surtout que, si l'on souhaite utiliser du [https://www.tala-informatique.fr/wiki/index.php/Esp8266_udp_server multicast], pour parler à un groupe d'enceintes, on ne peut le faire qu'en UDP !
== Envoi : serveur en PHP ==
La partie serveur prend un fichier, ici un MP3, lit un morceau du fichier et l'envoi à l'enceinte à travers une socket TCP. Deux paramètres sont à prendre en compte :
*le temps d'attente entre chaque envoi;
*la taille d'un morceau;
Ces paramètres nécessiteront certainement un temps d'ajustement qui sera en fonction de la latence, la congestion du réseau, les capacités des puces impliquées (ici l'ESP8266), etc...
{|style="width:650px" align="center"
|
[[Fichier:warning-icon.png|centré|60px]]
|valign="top" align="justify"|
Les extraits de code qui vont suivre respectent vaguement les préceptes, au combien importants, de la programmation orientée objet et sont fournis à titre indicatif dans l'unique but de démontrer la faisabilité d'un tel projet ! Voici [[:Media:Iot_Speaker.zip | l'archive]] qui contient le code exposé ci-dessous.
|}
=== MusicSender ===
Voici le contenu du fichier ''MusicSender.class.php'' :
<source lang="php">
<?php

class MusicSender
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5045;

// Le temps d'attente en microsecondes entre chaque paquets
private static $SLEEP_INTERVAL = 2500;

// La taille de chacun des paquets
private static $CHUNK_BUFFER = 32768;

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Envoie le MP3 à l'enceinte
*
* @param string $mp3File
* @return boolean
*/
public function play($mp3File)
{
if (is_file($mp3File)) {
// Ouverture du fichier en lecture binaire
$file = fopen($mp3File, 'rb');
if ($file === FALSE) {
echo "Fail reading file " . $file . "\n";
return FALSE;
}
// Ouverture de la socket
$socket = $this->openSocket();
// Tant qu'on est pas à la fin du fichier
while (! feof($file)) {
// Envoie d'un "morceau" de taille CHUNK_BUFFER à l'enceinte
if (@socket_write($this->socket, fread($file, self::$CHUNK_BUFFER), self::$CHUNK_BUFFER) === FALSE) {
// Problème de socket (fermeture, déconnexion, etc...)
return FALSE;
}
usleep(self::$SLEEP_INTERVAL);
}
// Fermeture de la socket
$this->closeSocket();
// Fermeture du fichier
fclose($file);
return TRUE;
}
echo $file." does not exists !\n";
return FALSE;
}

/**
* Lit tous les mp3 présents dans le dossier
*
* @param string $dir
*/
public function readFolder($dir)
{
if (is_dir($dir)) {
// On récupére les fichiers sans les 2 premiers '.' et '..'
$files = array_slice(scandir($dir), 2);
foreach ($files as $file) {
// On créé le chemin absolu
$mp3File = $dir . DIRECTORY_SEPARATOR . $file;
// On test l'extension
if (pathinfo($file)["extension"] == "mp3") {
$this->play($mp3File);
}
}
return true;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) == FALSE) {
echo "socket_create_listen() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
if (socket_connect($this->socket, $this->ip, self::$PORT) == FALSE) {
echo "socket_bind() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
=== Launch.php ===
On créé un fichier ''Launch.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicSender.class.php';

$esp_ip = "192.168.1.200";

$dir = "!!chemin_vers_des_fichiers_mp3!!";

$sender = new MusicSender($esp_ip);

$sender->readFolder($dir);
</source>

== Réception : ESP8266 ==
{|style="width:650px" align="center"
|
[[Fichier:Warning manual.jpg|centré|300px]]
|valign="top" align="justify"|
Soyez sûr de comprendre la section sur [https://www.tala-informatique.fr/wiki/index.php/Arduino_sketch_writing| comment écrire un sketch] avant de poursuivre. Le code ci-dessous fait référence à des parties bien spécifiques, détaillées et expliquées dans la section suscitée.
|}
=== Partie WiFi ===
La première étape consiste à raccorder notre ''ESP'' au réseau WiFi !
<source lang="c">
#include <ESP8266WiFi.h>
#include <WiFiClient.h>

// WiFi Parameters //
const char ssid[] = "cfcasa";
const char password[] = "***********";
IPAddress ip(192, 168, 1, 200);
IPAddress gw(192, 168, 1, 254);
IPAddress mask(255, 255, 252, 0);

void setup() {
// on démarre le port série
Serial.begin(115200);
// On attend "un peu" que le buffer soit prêt
delay(10);
// On démarre le WiFi
initWiFi();
}

void loop() {
}

void initWiFi() {
// On efface la configuration précédente
WiFi.disconnect(true);
Serial.printf("\nConnexion a %s", ssid);
// Initialisation de la connection
WiFi.config(ip, gw, mask, gw);
WiFi.begin(ssid, password);
// Test pour déterminer quand la connection est prete
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(".");
}
// Affichage des informations
Serial.printf(" connecté\nAdresse IP: %s\n", WiFi.localIP().toString().c_str());
}
</source>
=== Lecteur MP3 ===
Vient ensuite la partie du lecteur MP3. Dans la partie des imports, ajoutez la ligne suivante :
<source lang="c">
#include <VS1053.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Parameters //
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
#define VOLUME 70 // volume level 0-100
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);
uint8_t volume_level = VOLUME;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le shield MP3
initMP3();
</source>
A la suite, on insère la fonction suivante :
<source lang="c">
void initMP3() {
SPI.begin();
// Démarrage du lecteur MP3
player.begin();
player.switchToMp3Mode();
player.setVolume(volume_level);
}
</source>
=== Récupération du stream MP3 ===
On va maintenant récupérer le flux envoyé depuis le serveur. Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Server parameters //
const uint16_t MP3_PORT = 5045;
WiFiServer server(MP3_PORT);
const uint16_t BUFFER_SIZE = 16384;
//const uint16_t BUFFER_SIZE = 32768;
byte buffer[BUFFER_SIZE + 1];
uint16_t byteRead = 0;
bool isBufferReady = false;
WiFiClient client;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur TCP
initMp3Server();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
void initMp3Server() {
// Démarrage du serveur TCP
server.begin();
Serial.printf("Ecoute TCP sur le port %d\n", MP3_PORT);
}

void readMp3() {
// Un client est connecté
if (client) {
// Si le client est toujours connecté...
if (client.connected()) {
// Tant que l'on reçoit de la musique
while (client.available() > 0) {
// On rempli le buffer avec le contenu du paquet TCP
buffer[byteRead++] = client.read();
// Si le buffer est plein
if (byteRead == BUFFER_SIZE) {
// On previent que le buffer est plein
isBufferReady = true;
// On sort de la boucle
break;
}
}
// Si le buffer est plein
if (isBufferReady) {
// On envoi tout au lecteur MP3
player.playChunk(buffer, byteRead);
// On RAZ le compteur de bytes
byteRead = 0;
}
} else {
// Si le client est déconneté
client = server.available();
// On prévient que le buffer est vide
isBufferReady = false;
// On RAZ le compteur de bytes
byteRead = 0;
Serial.println(F("Client disconnected"));
}
} else {
// On test la présence d'un client
client = server.available();
if (client) {
// Un client est connecté !
Serial.println(F("New client !"));
}
}
}
</source>
Enfin, on ajoute le ligne suivante dans la fonction ''loop()'' :
<source lang="c">
readMp3();
</source>
A ce stade, l'ESP devrait être capable de récupérer le flux et de le jouer !

= Envoi de commandes =
Envoyer de la musique c'est bien, pouvoir régler le volume c'est encore mieux !

La façon la plus simple d'adresser le problème c'est d'utiliser un autre port et, comme les messages sont petits, d'utiliser UDP.
== Partie Serveur ==
Dans la même veine, voici la classe qui permet d'envoyer les commandes :
<source lang="php">
<?php

class MusicHandler
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5046;

// Le port de l'enceinte connectée
private static $RETRIES = 3;

// Liste de commandes
private static $CMD_VOLUME = 'V';

private static $CMD_LOCATE = 'L';

private static $CMD_RESET = 'R';

private static $RESPONSE_NOK = 'N';

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Augmente le volume d'un incrément
*
* @return boolean
*/
public function volumeUp()
{
return $this->sendCommand(self::$CMD_VOLUME . "+");
}

/**
* Baisse le volume d'un incrément
*
* @return boolean
*/
public function volumeDown()
{
return $this->sendCommand(self::$CMD_VOLUME . "-");
}

/**
*
* @return boolean
*/
public function setVolume($volume)
{
if ($volume < 0 || $volume > 100) {
return false;
}
return $this->sendCommand(self::$CMD_VOLUME . $volume);
}

public function getVolume(){
return $this->sendCommand(self::$CMD_VOLUME);
}

/**
*
* @return boolean
*/
public function doReset()
{
return $this->sendCommand(self::$CMD_RESET);
}

public function doLocate(){
return $this->sendCommand(self::$CMD_LOCATE);
}

/**
* Envoie une commande au module
*
* @param string $message
*/
private function sendCommand($message)
{
$result = false;
if ($this->openSocket() !== FALSE) {
if (socket_sendto($this->socket, $message, strlen($message), 0, $this->ip, self::$PORT) !== FALSE) {
$result = $this->readAcknoledge();
}
}
$this->closeSocket();
return $result;
}

/**
* Attend la confirmation de la commande
*
* @return boolean
*/
private function readAcknoledge()
{
$buf = "";
$retries = 0;
while ($retries < self::$RETRIES) {
$byteReceived = socket_recvfrom($this->socket, $buf, 2048, 0, $this->ip, self::$PORT);
if ($byteReceived > 0) {
return $buf != self::$RESPONSE_NOK ? $buf : FALSE;
}
usleep(500000);
$retries ++;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) === FALSE) {
$errorcode = socket_last_error();
$errormsg = socket_strerror($errorcode);
echo ("Couldn't create socket: [$errorcode] $errormsg \n");
return false;
}
return true;
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
On créé un fichier ''Command.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicHandler.class.php';

$esp_ip = "192.168.1.200";

$handler = new MusicHandler($esp_ip);

// Exemple de commandes //
//$result = $handler->volumeUp();
//$result = $handler->getVolume();
//$result = $handler->doReset();
//$result = $handler->setVolume(70);

$result = $handler->doLocate();

echo $result !== FALSE ? "ok : $result\n" : "nok\n";
</source>
== Partie Cliente ==
Dans la partie des imports ajoutez la ligne suivante :
<source lang="c">
#include <WiFiUDP.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// Command Server parameters //
const uint16_t CMD_PORT = 5046;
// L'instance du serveur UDP
WiFiUDP udp;
// Liste de commandes
const char CMD_VOLUME = 'V';
const char CMD_LOCATE = 'L';
const char CMD_RESET = 'R';
const char RESPONSE_NOK[] = "N";

// Localisation parameters
uint8_t ledPin = LED_BUILTIN;
const uint16_t BLINK_FREQ = 500;
const uint8_t BLINK_REP = 60;
uint8_t repetition = 0;
uint32_t timer;
bool isLocate = false;
</source>
A la fin de la fonction setup() nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur UDP
initCmdServer();
// On prépare la led de localisation
initLocateLed();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
bool readCmd() {
if (udp.parsePacket() > 0) {
uint8_t len = udp.available();
char c = udp.read();
if (len == 1) {
if (c == CMD_RESET) {
player.softReset();
sendPacket(CMD_RESET);
return true;
} else if (c == CMD_VOLUME) {
sendPacket(volume_level);
return true;
} else if (c == CMD_LOCATE) {
if (!isLocate) {
locate(true);
sendPacket(CMD_LOCATE);
return true;
}
}
} else if (len == 2) {
char value = udp.read();
if (c == CMD_VOLUME) {
if (value == '+' && volume_level != 100) {
setVolume(volume_level + 1);
} else if (value == '-' && volume_level != 0) {
setVolume(volume_level - 1);
} else {
sendNack();
return false;
}
return true;
}
} else {
if (c == CMD_VOLUME) {
char value[4] = "0";
udp.read(value, 3);
uint8_t vol = atoi(value);
if (vol >= 0 && vol <= 100) {
setVolume(vol);
return true;
}
}
}
sendNack();
return false;
}
// Check if locate needs to be done
locate(false);
}
void locate(bool blink) {
if (blink) {
// Initialisation des variables
digitalWrite(ledPin, LOW);
isLocate = true;
repetition = 0;
timer = millis();
} else if (isLocate) {
// Calcule du temps
uint32_t elapsed = millis() - timer;
if (elapsed > BLINK_FREQ) {
repetition++;
if (repetition == BLINK_REP) {
// On a atteint le nombre de clignotements
isLocate = false;
digitalWrite(ledPin, HIGH);
} else {
// On fait clignoter la led
digitalWrite(ledPin, !digitalRead(ledPin));
timer = millis();
}
}
}
}

void setVolume(uint8_t vol) {
volume_level = vol;
Serial.printf("Setting volume to %d\n", volume_level);
player.setVolume(volume_level);
sendPacket(volume_level);
}

void sendNack() {
sendPacket(RESPONSE_NOK);
}

void sendPacket(const char content) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(const char content[]) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(int content) {
char value[4];
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(itoa(content, value, 10));
udp.endPacket();
}

void initCmdServer() {
// Démarrage du serveur TCP
udp.begin(CMD_PORT);
Serial.printf("Ecoute UDP sur le port %d\n", CMD_PORT);
}

void initLocateLed() {
pinMode(ledPin, OUTPUT);
digitalWrite(ledPin, HIGH);
}
</source>
L'ESP est maintenant capable de :
* monter / baisser le volume ;
* de faire un reset du lecteur MP3 (en cas de problème)
* de faire clignoter sa led pour être localisé facilement.

= Enceinte armbian =
Même objectif mais cette fois-ci avec Rygel, un lecteur DLNA.
==Installation ==
Le système:
<pre>
# apt-get update
</pre>
Le lecteur rygel:
<pre>
# apt-get -y install rygel-playbin
</pre>
Les différents plugins. Tout d'abord, récupérer les plugins en fonctions de la distribution:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | awk -F ' - ' '{print $1}')
</pre>
Ensuite on procéde à l'installation:
<pre>
# apt-get install ${plugins}
</pre>

== Création du fichier de service ==
Il suffit de créer le fichier ''/etc/systemd/system/rygel.service'':
<pre>
[Unit]
Description=Rygel service
After=network-online.target

[Service]
Type=simple
UMask=007
ExecStart=/usr/bin/rygel -g 5
Restart=on-failure

# Configures the time to wait before service is stopped forcefully.
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
On peut lancer le service et l'activer au démarrage
<pre>
# systemctl start rygel
# systemctl enable rygel
</pre>
== Désactivation des logs ==
Comme l'enceinte n'est pas à proprement parler un serveur exécutant un service critique, on peut désactiver le système de logging pour économiser la durée de vie de la carte SD:
<pre>
# systemctl stop rsyslog
# systemctl disable rsyslog
</pre>
== Ajustement du volume ==
Il faut maintenant mettre le volume au maximum coté Pi avec le mixer ALSA [https://fr.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture wikipedia] :
<pre>
# alsamixer
</pre>
[[Fichier:alsamixer armbian.png|centré]]
== Changement de la carte son par défaut ==
Une fois la carte son USB installée, il suffit d'utiliser la commande suivante pour voir son identifiant:
<pre>
# aplay -l
**** List of PLAYBACK Hardware Devices ****
card 0: sun4icodec [sun4i-codec], device 0: CDC PCM Codec-0 []
Subdevices: 1/1
Subdevice #0: subdevice #0
card 1: Device [USB Audio Device], device 0: USB Audio [USB Audio]
Subdevices: 0/1
Subdevice #0: subdevice #0
</pre>
La carte son avec l'ID ''0'' est celle intégrée au PI, celle avec l'ID ''1'' est la carte USB.
Pour dire à ALSA que c'est la carte avec l'ID ''1'' que l'on veut par défaut, il suffit de créer le fichier ''/etc/asound.conf'' avec les lignes suivantes:
<pre>
defaults.pcm.card 1
defaults.ctl.card 1
</pre>
La configuration est appliquée après un redémarrage !

== WiringPI==
===Installation===
Pour le Banana Pi M1:
<pre>
# cd /opt
# git clone https://github.com/LeMaker/WiringLMK.git
# cd WiringLMK
# chmod +x ./build
# ./build
</pre>
Pour le Raspberry Pi 2:
<pre>
# apt install -y wiringpi
</pre>

=== Utilisation===
Pour la lecture des états
<pre>
# gpio readall
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| | | 3.3v | | | 1 || 2 | | | 5v | | |
| 2 | 8 | SDA.1 | ALT5 | 0 | 3 || 4 | | | 5V | | |
| 3 | 9 | SCL.1 | ALT5 | 0 | 5 || 6 | | | 0v | | |
| 4 | 7 | GPIO. 7 | IN | 0 | 7 || 8 | 1 | ALT2 | TxD | 15 | 14 |
| | | 0v | | | 9 || 10 | 0 | IN | RxD | 16 | 15 |
| 17 | 0 | GPIO. 0 | IN | 0 | 11 || 12 | 0 | IN | GPIO. 1 | 1 | 18 |
| 27 | 2 | GPIO. 2 | IN | 0 | 13 || 14 | | | 0v | | |
| 22 | 3 | GPIO. 3 | IN | 0 | 15 || 16 | 0 | IN | GPIO. 4 | 4 | 23 |
| | | 3.3v | | | 17 || 18 | 0 | IN | GPIO. 5 | 5 | 24 |
| 10 | 12 | MOSI | ALT5 | 0 | 19 || 20 | | | 0v | | |
| 9 | 13 | MISO | ALT5 | 0 | 21 || 22 | 0 | IN | GPIO. 6 | 6 | 25 |
| 11 | 14 | SCLK | ALT5 | 0 | 23 || 24 | 0 | ALT5 | CE0 | 10 | 8 |
| | | 0v | | | 25 || 26 | 0 | ALT5 | CE1 | 11 | 7 |
| 0 | 30 | SDA.0 | IN | 1 | 27 || 28 | 1 | IN | SCL.0 | 31 | 1 |
| 5 | 21 | GPIO.21 | IN | 0 | 29 || 30 | | | 0v | | |
| 6 | 22 | GPIO.22 | ALT4 | 0 | 31 || 32 | 0 | ALT4 | GPIO.26 | 26 | 12 |
| 13 | 23 | GPIO.23 | IN | 0 | 33 || 34 | | | 0v | | |
| 19 | 24 | GPIO.24 | IN | 0 | 35 || 36 | 0 | IN | GPIO.27 | 27 | 16 |
| 26 | 25 | GPIO.25 | IN | 0 | 37 || 38 | 0 | IN | GPIO.28 | 28 | 20 |
| | | 0v | | | 39 || 40 | 0 | IN | GPIO.29 | 29 | 21 |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
</pre>
Ou d'un état:
<pre>
# gpio read 1
0
</pre>
Changement d'état:
<pre>
# gpio -1 write 8 0
</pre>

== Détection de musique ==
Il est possible de détecter si de la musique est en train d'être jouée sur le PI grâce à la commande suivante:
<pre>
# cat /proc/asound/card*/pcm*/sub*/status | grep RUNNING | wc -l
</pre>
Si cette commande renvoie ''1'' cela veut dire que ''state: RUNNING'' est présent dans un des fichiers d'une des cartes son.

Cette commande peu permettre de piloter un amplificateur au travers d'un relais piloté par une GPIO...

== Ajout du bluetooth ==
=== Paramétrage de la carte===
Il faut d'abord installer blueZ:
<pre>
# apt install -y bluez bluez-tools bluealsa
</pre>
Il faut créer le fichier ''/etc/bluetooth/audio.conf'':
<pre>
[General]
Enable=Source,Sink,Media,Socket
</pre>
éditez le fichier ''/etc/bluetooth/main.conf'' pour modifier les lignes suivantes:
<pre>
...
Class = 0x00041C
...
DiscoverableTimeout = 0
...
PairableTimeout = 0
...
</pre>
Il faut ensuite redémarrer le service ''bluetooth'' pour appairer le téléphone:
<pre>
# systemctl restart bluetooth
</pre>
=== Déclaration de services===
Avant d'aller plus loin, nous allons enregistrer deux commandes en tant que service système:
* ''bluealsa -p a2dp-sink &'' : qui permet de déclarer le PI comme point de terminaison A2DP (musique);
* ''bluealsa-aplay 00:00:00:00:00:00'' : qui permet de laisser passer la musique sur la carte son par défaut.
Pour cela nous allons utiliser la même technique que pour Rygel (plus haut):
* Dans le fichier ''/etc/systemd/system/blue-a2dp.service'':
<pre>
[Unit]
Description=Alsa A2DP service
After=bluetooth.target

[Service]
ExecStart=/usr/bin/bluealsa -p a2dp-sink
Restart=on-failure
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
* Dans le fichier ''/etc/systemd/system/blue-aplay.service'':
<pre>
[Unit]
Description=Alsa Aplay authorization service
After=bluetooth.target

[Service]
ExecStart=/usr/bin/bluealsa-aplay 00:00:00:00:00:00
Restart=on-failure
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
Il ne reste plus qu'à enregistrer les services:
<pre>
# systemctl start blue-a2dp.service
# systemctl start blue-aplay.service
# systemctl enable blue-aplay.service
# systemctl enable blue-a2dp.service
</pre>

=== Appairage ===
Il faut lancer l'utilitaire ''bluetoothctl'':
<pre>
# bluetoothctl
Agent registered
[bluetooth]#
[CHG] Device 0C:2C:54:1B:A3:A9 Connected: yes
[tala_phone]#
</pre>

Iot speaker

2019-07-19T17:28:57Z

Tala : /* Déclaration de services */

=Projet=
{|class="wikitable" width="100%"
|-valign=top
! Objectif !! Les acteurs !! Compétences !! Matériel
|-valign=top
||
Construire des enceintes sans-fils (sauf le courant) actives connectées capables de travailler en "groupe"
||
*[[User:Tala | Tala]]
*[[User:Nigdor |Nigdor]]
*[[User:Prandar |Prandar]]
||
*électronique
*C++ (microcontrôleur)
||
* microcontrôleur (esp8266)
* amplificateur audio (XPT8871, PAM8403, ...)
* décodeur MP3 (VS1053B)
* potentiomètre digital (X9C103S)
|}

= Choix de l'amplificateur =
A faire:
*Expliquer la différence entre classe AB et D (qualité sonore vs. éco énergie)
*Faire un tableau récapitulatif des caractéristiques des amplis:
** mono / stéréo / les deux
** tension de fonctionnement / consommation (5v, 12v, 24v, etc...)
** puissance (5w, 20w, 30w, etc...)
** impédance de sortie (2 x 4Ω, 1 x 8Ω, etc...)
** réponse fréquentielle ;
** résistance aux courts-circuits ;
** bruit pop (quand pas de musique);
** besoin d'un dissipateur ou non (effet joule à prévoir...)
** lien vers la documentation si besoin d'info(eg. pour le [https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932])
** le plus important : le ressenti !
==Classe AB==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
TDA7297
|align=center|
[[Fichier:TDA7297.png|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 15W
|align=center|
2A (peak)
|align=center|
6 - 18 V
|align=center|
OUI
|align=center|
Avec µControlleur<br>(p. 3/4)
|align=center|
Obligatoire
|align=center|
[http://www.st.com/content/ccc/resource/technical/document/datasheet/a3/eb/9b/59/dd/26/4a/27/CD00001048.pdf/files/CD00001048.pdf/jcr:content/translations/en.CD00001048.pdf TDA7297]
|align=left|
Super amplification sans distorsion !
<br>
Forte dissipation thermique à pleine puissance :
* 33W d'après la doc;
* vraiment très (trop) fort !
|}
</div>

==Classe D==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
XH-M531 (YDA138)
|align=center|
[[Fichier:XH-M531.jpg|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 10 W<br>
2 x 20 W
|align=center|
8 Ω<br>
4 Ω
|align=center|
12 - 15V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.ksp-electronics.com/product_files/8eeedc66ea8fbcdf2e74294037c2f389 YDA138]
|align=center|
|-valign="top"
|align=center|
PAM8403
|align=center|
[[Fichier:PAM8403.jpg|centré|100px]]
|align=center|
Stéréo
|align=center|
3W(*2 ?)
|align=center|
4 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
Reduit mais présent
|align=center|
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8403.pdf PAM8403]
|align=center|
|-valign="top"
|align=center|
PAM8610
|align=center|
[[Fichier:PAM8610.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 10 W
|align=center|
8 Ω
|align=center|
7 - 15 V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8610.pdf PAM8610]
|align=center|
|-valign="top"
|align=center|
XPT8871
|align=center|
[[Fichier:XPT8871.jpg|centré|120px]]
|align=center|
Mono
|align=center|
3.5w
<br>
5w
|align=center|
3 Ω
<br>
2 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[[Media:XPT8871.pdf|XPT8871]]
|align=left|
*Bien pour la voix, pas top pour la musique
|-valign="top"
|align=center|
TDA8932
|align=center|
[[Fichier:TDA8932.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2*15W
|align=center|
4 Ω
|align=center|
Entre 10 V et 36 V (Rechercher quel est le plus optimal)
|align=center|
OUI
|align=center|
NON
|align=center|

|align=center|
[https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932]
|align=center|
|-valign="top"
|align=center|
TPA3110
|align=center|
[[Fichier:TPA3110.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
15W/ch
|align=center|
8 Ω
|align=center|
16 V
|align=center|
OUI
|align=center|
NON
|align=center|
OUI
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3110d2.pdf TPA3110]
|align=left|
*Amplification moyenne
*Basses creuses
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3116
|align=center|
[[Fichier:TPA3116.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 50W<br>
2 x 15W
|align=center|
4 Ω<br>
8 Ω
|align=center|
21 V<br>
15 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI<br>
NON
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3116d2.pdf TPA3116]
|align=left|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3118
|align=center|
[[Fichier:TPA3118.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 30W
|align=center|
8 Ω
|align=center|
12 - 24 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI
|align=left|
[http://www.ti.com/lit/ds/symlink/tpa3118d2.pdf TPA3118]
|align=center|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|}
</div>

= Potentiomètre digital =
A faire

= Décodeur MP3 =
==Présentation==
Le décodeur MP3 choisi est le VS1053

[[Fichier:vs1053_board.jpg|centré|200px]]

Ce décodeur offre une interface SPI et permet de lire ainsi que d'enregistrer des fichiers aux formats :
* lecture :
**MP3 ;
**Ogg Vorbis (libre de droit) ;
**PCM;
**WAV;
* enregistrement :
**Ogg Vorbis(libre de droit) ;

==Documentation technique==
Voici la [[:Media:vs1053_doc.pdf|documentation du VS1053]], pour ceux qui voudraient écrire une librairie C++ !

== Schéma ==
Les tests ont été réalisés avec un WemOS D1 mini (ESP8266) :
<div align="center">
{|class="wikitable" width="85%"
! ESP8266 !! VS1053 !! Connections
|-valign=top
||
[[Fichier:wemos_D1_R2_mini_diagram.png|centré|470px]]
||
[[Fichier:vs1053_board_diagram.png|centré|300px]]
|align="center"|
{|class="wikitable"
! ESP8266 !! VS1053
|-
|align="center"| D0
|align="center"| XDCS
|-
|align="center"| D1
|align="center"| XoS (Cable Select)
|-
|align="center"| D3
|align="center"| DREQ
|-
|align="center"| D5
|align="center"| SCK (Serial ClocK)
|-
|align="center"| D6
|align="center"| MISO (Master In Slave Out)
|-
|align="center"| D7
|align="center"| MOSI (Master Out Slave In)
|-
|align="center"| RST
|align="center"| XRST
|-
|align="center"| 5V
|align="center"| 5V
|-
|align="center"| G
|align="center"| DGND
|}
|}
</div>
Vous devriez avoir quelque chose comme ça :

[[Fichier:wemos_D1_vs1053_diagram.jpg|centré|400px]]

== Programmation ==
Tout d'abord un grand merci à [https://github.com/baldram/ESP_VS1053_Library ''baldram''] pour sa [[Media:ESP_VS1053_Library.zip|librairie]] que nous allons utiliser !

Le plus simple est de regarder l'exemple ''SimpleMP3Player'' fourni avec la librairie :
<source lang="c">
// La fameuse librairie de baldram
#include <VS1053.h>
// Un MP3 au format binaire dans un tableau (le fichier est livré avec la librairie)
#include <helloMp3.h>
// Définition des port SPI utilisé (ici pour l'ESP8266)
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
// Définition du volume
#define VOLUME 80 // volume level 0-100
// Création de l'objet VS1053
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);

void setup () {
// Démarrage du SPI
SPI.begin();
// démarrage du VS1053
player.begin();
// Ligne nécessaire pour certain lecteur
player.switchToMp3Mode();
player.setVolume(VOLUME);
}

void loop() {
// On joue le MP3 dans le tableau
player.playChunk(helloMp3, sizeof(helloMp3));
// On attend 3 secondes
delay(3000);
}
</source>
Pour que cet exemple fonctionne, il faut soit copier le contenu de ''HelloMp3.h'' dans le fichier exemple, soit copier le fichier dans le répertoire de la librairie dans votre dossier ''Arduino''.

Une fois la compilation terminée, vous devriez entendre ''du bruit'' sortir du VS1053 !

= Flux musical =
La communication se fera en générant un flux entre le programme (PC) et l'enceinte (ESP8266). Ce flux, pour des raisons de simplicité, se fera en TCP car ce protocole gère les retransmissions, les tampons d'entrée / sortie, etc...

A terme, une application temps réel comme la musique mériterait de passer sur de l'UDP. Surtout que, si l'on souhaite utiliser du [https://www.tala-informatique.fr/wiki/index.php/Esp8266_udp_server multicast], pour parler à un groupe d'enceintes, on ne peut le faire qu'en UDP !
== Envoi : serveur en PHP ==
La partie serveur prend un fichier, ici un MP3, lit un morceau du fichier et l'envoi à l'enceinte à travers une socket TCP. Deux paramètres sont à prendre en compte :
*le temps d'attente entre chaque envoi;
*la taille d'un morceau;
Ces paramètres nécessiteront certainement un temps d'ajustement qui sera en fonction de la latence, la congestion du réseau, les capacités des puces impliquées (ici l'ESP8266), etc...
{|style="width:650px" align="center"
|
[[Fichier:warning-icon.png|centré|60px]]
|valign="top" align="justify"|
Les extraits de code qui vont suivre respectent vaguement les préceptes, au combien importants, de la programmation orientée objet et sont fournis à titre indicatif dans l'unique but de démontrer la faisabilité d'un tel projet ! Voici [[:Media:Iot_Speaker.zip | l'archive]] qui contient le code exposé ci-dessous.
|}
=== MusicSender ===
Voici le contenu du fichier ''MusicSender.class.php'' :
<source lang="php">
<?php

class MusicSender
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5045;

// Le temps d'attente en microsecondes entre chaque paquets
private static $SLEEP_INTERVAL = 2500;

// La taille de chacun des paquets
private static $CHUNK_BUFFER = 32768;

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Envoie le MP3 à l'enceinte
*
* @param string $mp3File
* @return boolean
*/
public function play($mp3File)
{
if (is_file($mp3File)) {
// Ouverture du fichier en lecture binaire
$file = fopen($mp3File, 'rb');
if ($file === FALSE) {
echo "Fail reading file " . $file . "\n";
return FALSE;
}
// Ouverture de la socket
$socket = $this->openSocket();
// Tant qu'on est pas à la fin du fichier
while (! feof($file)) {
// Envoie d'un "morceau" de taille CHUNK_BUFFER à l'enceinte
if (@socket_write($this->socket, fread($file, self::$CHUNK_BUFFER), self::$CHUNK_BUFFER) === FALSE) {
// Problème de socket (fermeture, déconnexion, etc...)
return FALSE;
}
usleep(self::$SLEEP_INTERVAL);
}
// Fermeture de la socket
$this->closeSocket();
// Fermeture du fichier
fclose($file);
return TRUE;
}
echo $file." does not exists !\n";
return FALSE;
}

/**
* Lit tous les mp3 présents dans le dossier
*
* @param string $dir
*/
public function readFolder($dir)
{
if (is_dir($dir)) {
// On récupére les fichiers sans les 2 premiers '.' et '..'
$files = array_slice(scandir($dir), 2);
foreach ($files as $file) {
// On créé le chemin absolu
$mp3File = $dir . DIRECTORY_SEPARATOR . $file;
// On test l'extension
if (pathinfo($file)["extension"] == "mp3") {
$this->play($mp3File);
}
}
return true;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) == FALSE) {
echo "socket_create_listen() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
if (socket_connect($this->socket, $this->ip, self::$PORT) == FALSE) {
echo "socket_bind() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
=== Launch.php ===
On créé un fichier ''Launch.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicSender.class.php';

$esp_ip = "192.168.1.200";

$dir = "!!chemin_vers_des_fichiers_mp3!!";

$sender = new MusicSender($esp_ip);

$sender->readFolder($dir);
</source>

== Réception : ESP8266 ==
{|style="width:650px" align="center"
|
[[Fichier:Warning manual.jpg|centré|300px]]
|valign="top" align="justify"|
Soyez sûr de comprendre la section sur [https://www.tala-informatique.fr/wiki/index.php/Arduino_sketch_writing| comment écrire un sketch] avant de poursuivre. Le code ci-dessous fait référence à des parties bien spécifiques, détaillées et expliquées dans la section suscitée.
|}
=== Partie WiFi ===
La première étape consiste à raccorder notre ''ESP'' au réseau WiFi !
<source lang="c">
#include <ESP8266WiFi.h>
#include <WiFiClient.h>

// WiFi Parameters //
const char ssid[] = "cfcasa";
const char password[] = "***********";
IPAddress ip(192, 168, 1, 200);
IPAddress gw(192, 168, 1, 254);
IPAddress mask(255, 255, 252, 0);

void setup() {
// on démarre le port série
Serial.begin(115200);
// On attend "un peu" que le buffer soit prêt
delay(10);
// On démarre le WiFi
initWiFi();
}

void loop() {
}

void initWiFi() {
// On efface la configuration précédente
WiFi.disconnect(true);
Serial.printf("\nConnexion a %s", ssid);
// Initialisation de la connection
WiFi.config(ip, gw, mask, gw);
WiFi.begin(ssid, password);
// Test pour déterminer quand la connection est prete
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(".");
}
// Affichage des informations
Serial.printf(" connecté\nAdresse IP: %s\n", WiFi.localIP().toString().c_str());
}
</source>
=== Lecteur MP3 ===
Vient ensuite la partie du lecteur MP3. Dans la partie des imports, ajoutez la ligne suivante :
<source lang="c">
#include <VS1053.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Parameters //
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
#define VOLUME 70 // volume level 0-100
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);
uint8_t volume_level = VOLUME;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le shield MP3
initMP3();
</source>
A la suite, on insère la fonction suivante :
<source lang="c">
void initMP3() {
SPI.begin();
// Démarrage du lecteur MP3
player.begin();
player.switchToMp3Mode();
player.setVolume(volume_level);
}
</source>
=== Récupération du stream MP3 ===
On va maintenant récupérer le flux envoyé depuis le serveur. Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Server parameters //
const uint16_t MP3_PORT = 5045;
WiFiServer server(MP3_PORT);
const uint16_t BUFFER_SIZE = 16384;
//const uint16_t BUFFER_SIZE = 32768;
byte buffer[BUFFER_SIZE + 1];
uint16_t byteRead = 0;
bool isBufferReady = false;
WiFiClient client;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur TCP
initMp3Server();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
void initMp3Server() {
// Démarrage du serveur TCP
server.begin();
Serial.printf("Ecoute TCP sur le port %d\n", MP3_PORT);
}

void readMp3() {
// Un client est connecté
if (client) {
// Si le client est toujours connecté...
if (client.connected()) {
// Tant que l'on reçoit de la musique
while (client.available() > 0) {
// On rempli le buffer avec le contenu du paquet TCP
buffer[byteRead++] = client.read();
// Si le buffer est plein
if (byteRead == BUFFER_SIZE) {
// On previent que le buffer est plein
isBufferReady = true;
// On sort de la boucle
break;
}
}
// Si le buffer est plein
if (isBufferReady) {
// On envoi tout au lecteur MP3
player.playChunk(buffer, byteRead);
// On RAZ le compteur de bytes
byteRead = 0;
}
} else {
// Si le client est déconneté
client = server.available();
// On prévient que le buffer est vide
isBufferReady = false;
// On RAZ le compteur de bytes
byteRead = 0;
Serial.println(F("Client disconnected"));
}
} else {
// On test la présence d'un client
client = server.available();
if (client) {
// Un client est connecté !
Serial.println(F("New client !"));
}
}
}
</source>
Enfin, on ajoute le ligne suivante dans la fonction ''loop()'' :
<source lang="c">
readMp3();
</source>
A ce stade, l'ESP devrait être capable de récupérer le flux et de le jouer !

= Envoi de commandes =
Envoyer de la musique c'est bien, pouvoir régler le volume c'est encore mieux !

La façon la plus simple d'adresser le problème c'est d'utiliser un autre port et, comme les messages sont petits, d'utiliser UDP.
== Partie Serveur ==
Dans la même veine, voici la classe qui permet d'envoyer les commandes :
<source lang="php">
<?php

class MusicHandler
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5046;

// Le port de l'enceinte connectée
private static $RETRIES = 3;

// Liste de commandes
private static $CMD_VOLUME = 'V';

private static $CMD_LOCATE = 'L';

private static $CMD_RESET = 'R';

private static $RESPONSE_NOK = 'N';

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Augmente le volume d'un incrément
*
* @return boolean
*/
public function volumeUp()
{
return $this->sendCommand(self::$CMD_VOLUME . "+");
}

/**
* Baisse le volume d'un incrément
*
* @return boolean
*/
public function volumeDown()
{
return $this->sendCommand(self::$CMD_VOLUME . "-");
}

/**
*
* @return boolean
*/
public function setVolume($volume)
{
if ($volume < 0 || $volume > 100) {
return false;
}
return $this->sendCommand(self::$CMD_VOLUME . $volume);
}

public function getVolume(){
return $this->sendCommand(self::$CMD_VOLUME);
}

/**
*
* @return boolean
*/
public function doReset()
{
return $this->sendCommand(self::$CMD_RESET);
}

public function doLocate(){
return $this->sendCommand(self::$CMD_LOCATE);
}

/**
* Envoie une commande au module
*
* @param string $message
*/
private function sendCommand($message)
{
$result = false;
if ($this->openSocket() !== FALSE) {
if (socket_sendto($this->socket, $message, strlen($message), 0, $this->ip, self::$PORT) !== FALSE) {
$result = $this->readAcknoledge();
}
}
$this->closeSocket();
return $result;
}

/**
* Attend la confirmation de la commande
*
* @return boolean
*/
private function readAcknoledge()
{
$buf = "";
$retries = 0;
while ($retries < self::$RETRIES) {
$byteReceived = socket_recvfrom($this->socket, $buf, 2048, 0, $this->ip, self::$PORT);
if ($byteReceived > 0) {
return $buf != self::$RESPONSE_NOK ? $buf : FALSE;
}
usleep(500000);
$retries ++;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) === FALSE) {
$errorcode = socket_last_error();
$errormsg = socket_strerror($errorcode);
echo ("Couldn't create socket: [$errorcode] $errormsg \n");
return false;
}
return true;
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
On créé un fichier ''Command.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicHandler.class.php';

$esp_ip = "192.168.1.200";

$handler = new MusicHandler($esp_ip);

// Exemple de commandes //
//$result = $handler->volumeUp();
//$result = $handler->getVolume();
//$result = $handler->doReset();
//$result = $handler->setVolume(70);

$result = $handler->doLocate();

echo $result !== FALSE ? "ok : $result\n" : "nok\n";
</source>
== Partie Cliente ==
Dans la partie des imports ajoutez la ligne suivante :
<source lang="c">
#include <WiFiUDP.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// Command Server parameters //
const uint16_t CMD_PORT = 5046;
// L'instance du serveur UDP
WiFiUDP udp;
// Liste de commandes
const char CMD_VOLUME = 'V';
const char CMD_LOCATE = 'L';
const char CMD_RESET = 'R';
const char RESPONSE_NOK[] = "N";

// Localisation parameters
uint8_t ledPin = LED_BUILTIN;
const uint16_t BLINK_FREQ = 500;
const uint8_t BLINK_REP = 60;
uint8_t repetition = 0;
uint32_t timer;
bool isLocate = false;
</source>
A la fin de la fonction setup() nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur UDP
initCmdServer();
// On prépare la led de localisation
initLocateLed();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
bool readCmd() {
if (udp.parsePacket() > 0) {
uint8_t len = udp.available();
char c = udp.read();
if (len == 1) {
if (c == CMD_RESET) {
player.softReset();
sendPacket(CMD_RESET);
return true;
} else if (c == CMD_VOLUME) {
sendPacket(volume_level);
return true;
} else if (c == CMD_LOCATE) {
if (!isLocate) {
locate(true);
sendPacket(CMD_LOCATE);
return true;
}
}
} else if (len == 2) {
char value = udp.read();
if (c == CMD_VOLUME) {
if (value == '+' && volume_level != 100) {
setVolume(volume_level + 1);
} else if (value == '-' && volume_level != 0) {
setVolume(volume_level - 1);
} else {
sendNack();
return false;
}
return true;
}
} else {
if (c == CMD_VOLUME) {
char value[4] = "0";
udp.read(value, 3);
uint8_t vol = atoi(value);
if (vol >= 0 && vol <= 100) {
setVolume(vol);
return true;
}
}
}
sendNack();
return false;
}
// Check if locate needs to be done
locate(false);
}
void locate(bool blink) {
if (blink) {
// Initialisation des variables
digitalWrite(ledPin, LOW);
isLocate = true;
repetition = 0;
timer = millis();
} else if (isLocate) {
// Calcule du temps
uint32_t elapsed = millis() - timer;
if (elapsed > BLINK_FREQ) {
repetition++;
if (repetition == BLINK_REP) {
// On a atteint le nombre de clignotements
isLocate = false;
digitalWrite(ledPin, HIGH);
} else {
// On fait clignoter la led
digitalWrite(ledPin, !digitalRead(ledPin));
timer = millis();
}
}
}
}

void setVolume(uint8_t vol) {
volume_level = vol;
Serial.printf("Setting volume to %d\n", volume_level);
player.setVolume(volume_level);
sendPacket(volume_level);
}

void sendNack() {
sendPacket(RESPONSE_NOK);
}

void sendPacket(const char content) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(const char content[]) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(int content) {
char value[4];
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(itoa(content, value, 10));
udp.endPacket();
}

void initCmdServer() {
// Démarrage du serveur TCP
udp.begin(CMD_PORT);
Serial.printf("Ecoute UDP sur le port %d\n", CMD_PORT);
}

void initLocateLed() {
pinMode(ledPin, OUTPUT);
digitalWrite(ledPin, HIGH);
}
</source>
L'ESP est maintenant capable de :
* monter / baisser le volume ;
* de faire un reset du lecteur MP3 (en cas de problème)
* de faire clignoter sa led pour être localisé facilement.

= Enceinte armbian =
Même objectif mais cette fois-ci avec Rygel, un lecteur DLNA.
==Installation ==
Le système:
<pre>
# apt-get update
</pre>
Le lecteur rygel:
<pre>
# apt-get -y install rygel-playbin
</pre>
Les différents plugins. Tout d'abord, récupérer les plugins en fonctions de la distribution:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | awk -F ' - ' '{print $1}')
</pre>
Ensuite on procéde à l'installation:
<pre>
# apt-get install ${plugins}
</pre>

== Création du fichier de service ==
Il suffit de créer le fichier ''/etc/systemd/system/rygel.service'':
<pre>
[Unit]
Description=Rygel service
After=network-online.target

[Service]
Type=simple
UMask=007
ExecStart=/usr/bin/rygel -g 5
Restart=on-failure

# Configures the time to wait before service is stopped forcefully.
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
On peut lancer le service et l'activer au démarrage
<pre>
# systemctl start rygel
# systemctl enable rygel
</pre>
== Désactivation des logs ==
Comme l'enceinte n'est pas à proprement parler un serveur exécutant un service critique, on peut désactiver le système de logging pour économiser la durée de vie de la carte SD:
<pre>
# systemctl stop rsyslog
# systemctl disable rsyslog
</pre>
== Ajustement du volume ==
Il faut maintenant mettre le volume au maximum coté Pi avec le mixer ALSA [https://fr.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture wikipedia] :
<pre>
# alsamixer
</pre>
[[Fichier:alsamixer armbian.png|centré]]
== Changement de la carte son par défaut ==
Une fois la carte son USB installée, il suffit d'utiliser la commande suivante pour voir son identifiant:
<pre>
# aplay -l
**** List of PLAYBACK Hardware Devices ****
card 0: sun4icodec [sun4i-codec], device 0: CDC PCM Codec-0 []
Subdevices: 1/1
Subdevice #0: subdevice #0
card 1: Device [USB Audio Device], device 0: USB Audio [USB Audio]
Subdevices: 0/1
Subdevice #0: subdevice #0
</pre>
La carte son avec l'ID ''0'' est celle intégrée au PI, celle avec l'ID ''1'' est la carte USB.
Pour dire à ALSA que c'est la carte avec l'ID ''1'' que l'on veut par défaut, il suffit de créer le fichier ''/etc/asound.conf'' avec les lignes suivantes:
<pre>
defaults.pcm.card 1
defaults.ctl.card 1
</pre>
La configuration est appliquée après un redémarrage !

== WiringPI==
===Installation===
Pour le Banana Pi M1:
<pre>
# cd /opt
# git clone https://github.com/LeMaker/WiringLMK.git
# cd WiringLMK
# chmod +x ./build
# ./build
</pre>
Pour le Raspberry Pi 2:
<pre>
# apt install -y wiringpi
</pre>

=== Utilisation===
Pour la lecture des états
<pre>
# gpio readall
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| | | 3.3v | | | 1 || 2 | | | 5v | | |
| 2 | 8 | SDA.1 | ALT5 | 0 | 3 || 4 | | | 5V | | |
| 3 | 9 | SCL.1 | ALT5 | 0 | 5 || 6 | | | 0v | | |
| 4 | 7 | GPIO. 7 | IN | 0 | 7 || 8 | 1 | ALT2 | TxD | 15 | 14 |
| | | 0v | | | 9 || 10 | 0 | IN | RxD | 16 | 15 |
| 17 | 0 | GPIO. 0 | IN | 0 | 11 || 12 | 0 | IN | GPIO. 1 | 1 | 18 |
| 27 | 2 | GPIO. 2 | IN | 0 | 13 || 14 | | | 0v | | |
| 22 | 3 | GPIO. 3 | IN | 0 | 15 || 16 | 0 | IN | GPIO. 4 | 4 | 23 |
| | | 3.3v | | | 17 || 18 | 0 | IN | GPIO. 5 | 5 | 24 |
| 10 | 12 | MOSI | ALT5 | 0 | 19 || 20 | | | 0v | | |
| 9 | 13 | MISO | ALT5 | 0 | 21 || 22 | 0 | IN | GPIO. 6 | 6 | 25 |
| 11 | 14 | SCLK | ALT5 | 0 | 23 || 24 | 0 | ALT5 | CE0 | 10 | 8 |
| | | 0v | | | 25 || 26 | 0 | ALT5 | CE1 | 11 | 7 |
| 0 | 30 | SDA.0 | IN | 1 | 27 || 28 | 1 | IN | SCL.0 | 31 | 1 |
| 5 | 21 | GPIO.21 | IN | 0 | 29 || 30 | | | 0v | | |
| 6 | 22 | GPIO.22 | ALT4 | 0 | 31 || 32 | 0 | ALT4 | GPIO.26 | 26 | 12 |
| 13 | 23 | GPIO.23 | IN | 0 | 33 || 34 | | | 0v | | |
| 19 | 24 | GPIO.24 | IN | 0 | 35 || 36 | 0 | IN | GPIO.27 | 27 | 16 |
| 26 | 25 | GPIO.25 | IN | 0 | 37 || 38 | 0 | IN | GPIO.28 | 28 | 20 |
| | | 0v | | | 39 || 40 | 0 | IN | GPIO.29 | 29 | 21 |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
</pre>
Ou d'un état:
<pre>
# gpio read 1
0
</pre>
Changement d'état:
<pre>
# gpio -1 write 8 0
</pre>

== Détection de musique ==
Il est possible de détecter si de la musique est en train d'être jouée sur le PI grâce à la commande suivante:
<pre>
# cat /proc/asound/card*/pcm*/sub*/status | grep RUNNING | wc -l
</pre>
Si cette commande renvoie ''1'' cela veut dire que ''state: RUNNING'' est présent dans un des fichiers d'une des cartes son.

Cette commande peu permettre de piloter un amplificateur au travers d'un relais piloté par une GPIO...

== Ajout du bluetooth ==
=== Paramétrage de la carte===
Il faut d'abord installer blueZ:
<pre>
# apt install -y bluez bluez-tools bluealsa
</pre>
Il faut créer le fichier ''/etc/bluetooth/audio.conf'':
<pre>
[General]
Enable=Source,Sink,Media,Socket
</pre>
éditez le fichier ''/etc/bluetooth/main.conf'' pour modifier les lignes suivantes:
<pre>
...
Class = 0x00041C
...
DiscoverableTimeout = 0
...
PairableTimeout = 0
...
</pre>
Il faut ensuite redémarrer le service ''bluetooth'' pour appairer le téléphone:
<pre>
# systemctl restart bluetooth
</pre>
=== Déclaration de services===
Avant d'aller plus loin, nous allons enregistrer deux commandes en tant que service système:
* ''bluealsa -p a2dp-sink &'' : qui permet de déclarer le PI comme point de terminaison A2DP (musique);
* ''bluealsa-aplay 00:00:00:00:00:00'' : qui permet de laisser passer la musique sur la carte son par défaut.
Pour cela nous allons utiliser la même technique que pour Rygel (plus haut):
* Dans le fichier ''/etc/systemd/system/blue-a2dp.service'':
<pre>
[Unit]
Description=Alsa A2DP service
After=bluetooth.target

[Service]
ExecStart=/usr/bin/bluealsa -p a2dp-sink
Restart=on-failure
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
* Dans le fichier ''/etc/systemd/system/blue-aplay.service'':
<pre>
[Unit]
Description=Alsa Aplay authorization service
After=bluetooth.target

[Service]
ExecStart=/usr/bin/bluealsa-aplay 00:00:00:00:00:00 &
Restart=on-failure
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
Il ne reste plus qu'à enregistrer les services:
<pre>
# systemctl start blue-a2dp.service
# systemctl start blue-aplay.service
# systemctl enable blue-aplay.service
# systemctl enable blue-a2dp.service
</pre>

=== Appairage ===
Il faut lancer l'utilitaire ''bluetoothctl'':
<pre>
# bluetoothctl
Agent registered
[bluetooth]#
[CHG] Device 0C:2C:54:1B:A3:A9 Connected: yes
[tala_phone]#
</pre>

Iot speaker

2019-07-19T17:26:52Z

Tala : /* Ajout du bluetooth */

=Projet=
{|class="wikitable" width="100%"
|-valign=top
! Objectif !! Les acteurs !! Compétences !! Matériel
|-valign=top
||
Construire des enceintes sans-fils (sauf le courant) actives connectées capables de travailler en "groupe"
||
*[[User:Tala | Tala]]
*[[User:Nigdor |Nigdor]]
*[[User:Prandar |Prandar]]
||
*électronique
*C++ (microcontrôleur)
||
* microcontrôleur (esp8266)
* amplificateur audio (XPT8871, PAM8403, ...)
* décodeur MP3 (VS1053B)
* potentiomètre digital (X9C103S)
|}

= Choix de l'amplificateur =
A faire:
*Expliquer la différence entre classe AB et D (qualité sonore vs. éco énergie)
*Faire un tableau récapitulatif des caractéristiques des amplis:
** mono / stéréo / les deux
** tension de fonctionnement / consommation (5v, 12v, 24v, etc...)
** puissance (5w, 20w, 30w, etc...)
** impédance de sortie (2 x 4Ω, 1 x 8Ω, etc...)
** réponse fréquentielle ;
** résistance aux courts-circuits ;
** bruit pop (quand pas de musique);
** besoin d'un dissipateur ou non (effet joule à prévoir...)
** lien vers la documentation si besoin d'info(eg. pour le [https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932])
** le plus important : le ressenti !
==Classe AB==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
TDA7297
|align=center|
[[Fichier:TDA7297.png|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 15W
|align=center|
2A (peak)
|align=center|
6 - 18 V
|align=center|
OUI
|align=center|
Avec µControlleur<br>(p. 3/4)
|align=center|
Obligatoire
|align=center|
[http://www.st.com/content/ccc/resource/technical/document/datasheet/a3/eb/9b/59/dd/26/4a/27/CD00001048.pdf/files/CD00001048.pdf/jcr:content/translations/en.CD00001048.pdf TDA7297]
|align=left|
Super amplification sans distorsion !
<br>
Forte dissipation thermique à pleine puissance :
* 33W d'après la doc;
* vraiment très (trop) fort !
|}
</div>

==Classe D==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
XH-M531 (YDA138)
|align=center|
[[Fichier:XH-M531.jpg|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 10 W<br>
2 x 20 W
|align=center|
8 Ω<br>
4 Ω
|align=center|
12 - 15V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.ksp-electronics.com/product_files/8eeedc66ea8fbcdf2e74294037c2f389 YDA138]
|align=center|
|-valign="top"
|align=center|
PAM8403
|align=center|
[[Fichier:PAM8403.jpg|centré|100px]]
|align=center|
Stéréo
|align=center|
3W(*2 ?)
|align=center|
4 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
Reduit mais présent
|align=center|
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8403.pdf PAM8403]
|align=center|
|-valign="top"
|align=center|
PAM8610
|align=center|
[[Fichier:PAM8610.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 10 W
|align=center|
8 Ω
|align=center|
7 - 15 V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8610.pdf PAM8610]
|align=center|
|-valign="top"
|align=center|
XPT8871
|align=center|
[[Fichier:XPT8871.jpg|centré|120px]]
|align=center|
Mono
|align=center|
3.5w
<br>
5w
|align=center|
3 Ω
<br>
2 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[[Media:XPT8871.pdf|XPT8871]]
|align=left|
*Bien pour la voix, pas top pour la musique
|-valign="top"
|align=center|
TDA8932
|align=center|
[[Fichier:TDA8932.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2*15W
|align=center|
4 Ω
|align=center|
Entre 10 V et 36 V (Rechercher quel est le plus optimal)
|align=center|
OUI
|align=center|
NON
|align=center|

|align=center|
[https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932]
|align=center|
|-valign="top"
|align=center|
TPA3110
|align=center|
[[Fichier:TPA3110.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
15W/ch
|align=center|
8 Ω
|align=center|
16 V
|align=center|
OUI
|align=center|
NON
|align=center|
OUI
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3110d2.pdf TPA3110]
|align=left|
*Amplification moyenne
*Basses creuses
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3116
|align=center|
[[Fichier:TPA3116.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 50W<br>
2 x 15W
|align=center|
4 Ω<br>
8 Ω
|align=center|
21 V<br>
15 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI<br>
NON
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3116d2.pdf TPA3116]
|align=left|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3118
|align=center|
[[Fichier:TPA3118.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 30W
|align=center|
8 Ω
|align=center|
12 - 24 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI
|align=left|
[http://www.ti.com/lit/ds/symlink/tpa3118d2.pdf TPA3118]
|align=center|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|}
</div>

= Potentiomètre digital =
A faire

= Décodeur MP3 =
==Présentation==
Le décodeur MP3 choisi est le VS1053

[[Fichier:vs1053_board.jpg|centré|200px]]

Ce décodeur offre une interface SPI et permet de lire ainsi que d'enregistrer des fichiers aux formats :
* lecture :
**MP3 ;
**Ogg Vorbis (libre de droit) ;
**PCM;
**WAV;
* enregistrement :
**Ogg Vorbis(libre de droit) ;

==Documentation technique==
Voici la [[:Media:vs1053_doc.pdf|documentation du VS1053]], pour ceux qui voudraient écrire une librairie C++ !

== Schéma ==
Les tests ont été réalisés avec un WemOS D1 mini (ESP8266) :
<div align="center">
{|class="wikitable" width="85%"
! ESP8266 !! VS1053 !! Connections
|-valign=top
||
[[Fichier:wemos_D1_R2_mini_diagram.png|centré|470px]]
||
[[Fichier:vs1053_board_diagram.png|centré|300px]]
|align="center"|
{|class="wikitable"
! ESP8266 !! VS1053
|-
|align="center"| D0
|align="center"| XDCS
|-
|align="center"| D1
|align="center"| XoS (Cable Select)
|-
|align="center"| D3
|align="center"| DREQ
|-
|align="center"| D5
|align="center"| SCK (Serial ClocK)
|-
|align="center"| D6
|align="center"| MISO (Master In Slave Out)
|-
|align="center"| D7
|align="center"| MOSI (Master Out Slave In)
|-
|align="center"| RST
|align="center"| XRST
|-
|align="center"| 5V
|align="center"| 5V
|-
|align="center"| G
|align="center"| DGND
|}
|}
</div>
Vous devriez avoir quelque chose comme ça :

[[Fichier:wemos_D1_vs1053_diagram.jpg|centré|400px]]

== Programmation ==
Tout d'abord un grand merci à [https://github.com/baldram/ESP_VS1053_Library ''baldram''] pour sa [[Media:ESP_VS1053_Library.zip|librairie]] que nous allons utiliser !

Le plus simple est de regarder l'exemple ''SimpleMP3Player'' fourni avec la librairie :
<source lang="c">
// La fameuse librairie de baldram
#include <VS1053.h>
// Un MP3 au format binaire dans un tableau (le fichier est livré avec la librairie)
#include <helloMp3.h>
// Définition des port SPI utilisé (ici pour l'ESP8266)
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
// Définition du volume
#define VOLUME 80 // volume level 0-100
// Création de l'objet VS1053
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);

void setup () {
// Démarrage du SPI
SPI.begin();
// démarrage du VS1053
player.begin();
// Ligne nécessaire pour certain lecteur
player.switchToMp3Mode();
player.setVolume(VOLUME);
}

void loop() {
// On joue le MP3 dans le tableau
player.playChunk(helloMp3, sizeof(helloMp3));
// On attend 3 secondes
delay(3000);
}
</source>
Pour que cet exemple fonctionne, il faut soit copier le contenu de ''HelloMp3.h'' dans le fichier exemple, soit copier le fichier dans le répertoire de la librairie dans votre dossier ''Arduino''.

Une fois la compilation terminée, vous devriez entendre ''du bruit'' sortir du VS1053 !

= Flux musical =
La communication se fera en générant un flux entre le programme (PC) et l'enceinte (ESP8266). Ce flux, pour des raisons de simplicité, se fera en TCP car ce protocole gère les retransmissions, les tampons d'entrée / sortie, etc...

A terme, une application temps réel comme la musique mériterait de passer sur de l'UDP. Surtout que, si l'on souhaite utiliser du [https://www.tala-informatique.fr/wiki/index.php/Esp8266_udp_server multicast], pour parler à un groupe d'enceintes, on ne peut le faire qu'en UDP !
== Envoi : serveur en PHP ==
La partie serveur prend un fichier, ici un MP3, lit un morceau du fichier et l'envoi à l'enceinte à travers une socket TCP. Deux paramètres sont à prendre en compte :
*le temps d'attente entre chaque envoi;
*la taille d'un morceau;
Ces paramètres nécessiteront certainement un temps d'ajustement qui sera en fonction de la latence, la congestion du réseau, les capacités des puces impliquées (ici l'ESP8266), etc...
{|style="width:650px" align="center"
|
[[Fichier:warning-icon.png|centré|60px]]
|valign="top" align="justify"|
Les extraits de code qui vont suivre respectent vaguement les préceptes, au combien importants, de la programmation orientée objet et sont fournis à titre indicatif dans l'unique but de démontrer la faisabilité d'un tel projet ! Voici [[:Media:Iot_Speaker.zip | l'archive]] qui contient le code exposé ci-dessous.
|}
=== MusicSender ===
Voici le contenu du fichier ''MusicSender.class.php'' :
<source lang="php">
<?php

class MusicSender
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5045;

// Le temps d'attente en microsecondes entre chaque paquets
private static $SLEEP_INTERVAL = 2500;

// La taille de chacun des paquets
private static $CHUNK_BUFFER = 32768;

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Envoie le MP3 à l'enceinte
*
* @param string $mp3File
* @return boolean
*/
public function play($mp3File)
{
if (is_file($mp3File)) {
// Ouverture du fichier en lecture binaire
$file = fopen($mp3File, 'rb');
if ($file === FALSE) {
echo "Fail reading file " . $file . "\n";
return FALSE;
}
// Ouverture de la socket
$socket = $this->openSocket();
// Tant qu'on est pas à la fin du fichier
while (! feof($file)) {
// Envoie d'un "morceau" de taille CHUNK_BUFFER à l'enceinte
if (@socket_write($this->socket, fread($file, self::$CHUNK_BUFFER), self::$CHUNK_BUFFER) === FALSE) {
// Problème de socket (fermeture, déconnexion, etc...)
return FALSE;
}
usleep(self::$SLEEP_INTERVAL);
}
// Fermeture de la socket
$this->closeSocket();
// Fermeture du fichier
fclose($file);
return TRUE;
}
echo $file." does not exists !\n";
return FALSE;
}

/**
* Lit tous les mp3 présents dans le dossier
*
* @param string $dir
*/
public function readFolder($dir)
{
if (is_dir($dir)) {
// On récupére les fichiers sans les 2 premiers '.' et '..'
$files = array_slice(scandir($dir), 2);
foreach ($files as $file) {
// On créé le chemin absolu
$mp3File = $dir . DIRECTORY_SEPARATOR . $file;
// On test l'extension
if (pathinfo($file)["extension"] == "mp3") {
$this->play($mp3File);
}
}
return true;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) == FALSE) {
echo "socket_create_listen() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
if (socket_connect($this->socket, $this->ip, self::$PORT) == FALSE) {
echo "socket_bind() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
=== Launch.php ===
On créé un fichier ''Launch.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicSender.class.php';

$esp_ip = "192.168.1.200";

$dir = "!!chemin_vers_des_fichiers_mp3!!";

$sender = new MusicSender($esp_ip);

$sender->readFolder($dir);
</source>

== Réception : ESP8266 ==
{|style="width:650px" align="center"
|
[[Fichier:Warning manual.jpg|centré|300px]]
|valign="top" align="justify"|
Soyez sûr de comprendre la section sur [https://www.tala-informatique.fr/wiki/index.php/Arduino_sketch_writing| comment écrire un sketch] avant de poursuivre. Le code ci-dessous fait référence à des parties bien spécifiques, détaillées et expliquées dans la section suscitée.
|}
=== Partie WiFi ===
La première étape consiste à raccorder notre ''ESP'' au réseau WiFi !
<source lang="c">
#include <ESP8266WiFi.h>
#include <WiFiClient.h>

// WiFi Parameters //
const char ssid[] = "cfcasa";
const char password[] = "***********";
IPAddress ip(192, 168, 1, 200);
IPAddress gw(192, 168, 1, 254);
IPAddress mask(255, 255, 252, 0);

void setup() {
// on démarre le port série
Serial.begin(115200);
// On attend "un peu" que le buffer soit prêt
delay(10);
// On démarre le WiFi
initWiFi();
}

void loop() {
}

void initWiFi() {
// On efface la configuration précédente
WiFi.disconnect(true);
Serial.printf("\nConnexion a %s", ssid);
// Initialisation de la connection
WiFi.config(ip, gw, mask, gw);
WiFi.begin(ssid, password);
// Test pour déterminer quand la connection est prete
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(".");
}
// Affichage des informations
Serial.printf(" connecté\nAdresse IP: %s\n", WiFi.localIP().toString().c_str());
}
</source>
=== Lecteur MP3 ===
Vient ensuite la partie du lecteur MP3. Dans la partie des imports, ajoutez la ligne suivante :
<source lang="c">
#include <VS1053.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Parameters //
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
#define VOLUME 70 // volume level 0-100
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);
uint8_t volume_level = VOLUME;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le shield MP3
initMP3();
</source>
A la suite, on insère la fonction suivante :
<source lang="c">
void initMP3() {
SPI.begin();
// Démarrage du lecteur MP3
player.begin();
player.switchToMp3Mode();
player.setVolume(volume_level);
}
</source>
=== Récupération du stream MP3 ===
On va maintenant récupérer le flux envoyé depuis le serveur. Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Server parameters //
const uint16_t MP3_PORT = 5045;
WiFiServer server(MP3_PORT);
const uint16_t BUFFER_SIZE = 16384;
//const uint16_t BUFFER_SIZE = 32768;
byte buffer[BUFFER_SIZE + 1];
uint16_t byteRead = 0;
bool isBufferReady = false;
WiFiClient client;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur TCP
initMp3Server();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
void initMp3Server() {
// Démarrage du serveur TCP
server.begin();
Serial.printf("Ecoute TCP sur le port %d\n", MP3_PORT);
}

void readMp3() {
// Un client est connecté
if (client) {
// Si le client est toujours connecté...
if (client.connected()) {
// Tant que l'on reçoit de la musique
while (client.available() > 0) {
// On rempli le buffer avec le contenu du paquet TCP
buffer[byteRead++] = client.read();
// Si le buffer est plein
if (byteRead == BUFFER_SIZE) {
// On previent que le buffer est plein
isBufferReady = true;
// On sort de la boucle
break;
}
}
// Si le buffer est plein
if (isBufferReady) {
// On envoi tout au lecteur MP3
player.playChunk(buffer, byteRead);
// On RAZ le compteur de bytes
byteRead = 0;
}
} else {
// Si le client est déconneté
client = server.available();
// On prévient que le buffer est vide
isBufferReady = false;
// On RAZ le compteur de bytes
byteRead = 0;
Serial.println(F("Client disconnected"));
}
} else {
// On test la présence d'un client
client = server.available();
if (client) {
// Un client est connecté !
Serial.println(F("New client !"));
}
}
}
</source>
Enfin, on ajoute le ligne suivante dans la fonction ''loop()'' :
<source lang="c">
readMp3();
</source>
A ce stade, l'ESP devrait être capable de récupérer le flux et de le jouer !

= Envoi de commandes =
Envoyer de la musique c'est bien, pouvoir régler le volume c'est encore mieux !

La façon la plus simple d'adresser le problème c'est d'utiliser un autre port et, comme les messages sont petits, d'utiliser UDP.
== Partie Serveur ==
Dans la même veine, voici la classe qui permet d'envoyer les commandes :
<source lang="php">
<?php

class MusicHandler
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5046;

// Le port de l'enceinte connectée
private static $RETRIES = 3;

// Liste de commandes
private static $CMD_VOLUME = 'V';

private static $CMD_LOCATE = 'L';

private static $CMD_RESET = 'R';

private static $RESPONSE_NOK = 'N';

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Augmente le volume d'un incrément
*
* @return boolean
*/
public function volumeUp()
{
return $this->sendCommand(self::$CMD_VOLUME . "+");
}

/**
* Baisse le volume d'un incrément
*
* @return boolean
*/
public function volumeDown()
{
return $this->sendCommand(self::$CMD_VOLUME . "-");
}

/**
*
* @return boolean
*/
public function setVolume($volume)
{
if ($volume < 0 || $volume > 100) {
return false;
}
return $this->sendCommand(self::$CMD_VOLUME . $volume);
}

public function getVolume(){
return $this->sendCommand(self::$CMD_VOLUME);
}

/**
*
* @return boolean
*/
public function doReset()
{
return $this->sendCommand(self::$CMD_RESET);
}

public function doLocate(){
return $this->sendCommand(self::$CMD_LOCATE);
}

/**
* Envoie une commande au module
*
* @param string $message
*/
private function sendCommand($message)
{
$result = false;
if ($this->openSocket() !== FALSE) {
if (socket_sendto($this->socket, $message, strlen($message), 0, $this->ip, self::$PORT) !== FALSE) {
$result = $this->readAcknoledge();
}
}
$this->closeSocket();
return $result;
}

/**
* Attend la confirmation de la commande
*
* @return boolean
*/
private function readAcknoledge()
{
$buf = "";
$retries = 0;
while ($retries < self::$RETRIES) {
$byteReceived = socket_recvfrom($this->socket, $buf, 2048, 0, $this->ip, self::$PORT);
if ($byteReceived > 0) {
return $buf != self::$RESPONSE_NOK ? $buf : FALSE;
}
usleep(500000);
$retries ++;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) === FALSE) {
$errorcode = socket_last_error();
$errormsg = socket_strerror($errorcode);
echo ("Couldn't create socket: [$errorcode] $errormsg \n");
return false;
}
return true;
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
On créé un fichier ''Command.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicHandler.class.php';

$esp_ip = "192.168.1.200";

$handler = new MusicHandler($esp_ip);

// Exemple de commandes //
//$result = $handler->volumeUp();
//$result = $handler->getVolume();
//$result = $handler->doReset();
//$result = $handler->setVolume(70);

$result = $handler->doLocate();

echo $result !== FALSE ? "ok : $result\n" : "nok\n";
</source>
== Partie Cliente ==
Dans la partie des imports ajoutez la ligne suivante :
<source lang="c">
#include <WiFiUDP.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// Command Server parameters //
const uint16_t CMD_PORT = 5046;
// L'instance du serveur UDP
WiFiUDP udp;
// Liste de commandes
const char CMD_VOLUME = 'V';
const char CMD_LOCATE = 'L';
const char CMD_RESET = 'R';
const char RESPONSE_NOK[] = "N";

// Localisation parameters
uint8_t ledPin = LED_BUILTIN;
const uint16_t BLINK_FREQ = 500;
const uint8_t BLINK_REP = 60;
uint8_t repetition = 0;
uint32_t timer;
bool isLocate = false;
</source>
A la fin de la fonction setup() nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur UDP
initCmdServer();
// On prépare la led de localisation
initLocateLed();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
bool readCmd() {
if (udp.parsePacket() > 0) {
uint8_t len = udp.available();
char c = udp.read();
if (len == 1) {
if (c == CMD_RESET) {
player.softReset();
sendPacket(CMD_RESET);
return true;
} else if (c == CMD_VOLUME) {
sendPacket(volume_level);
return true;
} else if (c == CMD_LOCATE) {
if (!isLocate) {
locate(true);
sendPacket(CMD_LOCATE);
return true;
}
}
} else if (len == 2) {
char value = udp.read();
if (c == CMD_VOLUME) {
if (value == '+' && volume_level != 100) {
setVolume(volume_level + 1);
} else if (value == '-' && volume_level != 0) {
setVolume(volume_level - 1);
} else {
sendNack();
return false;
}
return true;
}
} else {
if (c == CMD_VOLUME) {
char value[4] = "0";
udp.read(value, 3);
uint8_t vol = atoi(value);
if (vol >= 0 && vol <= 100) {
setVolume(vol);
return true;
}
}
}
sendNack();
return false;
}
// Check if locate needs to be done
locate(false);
}
void locate(bool blink) {
if (blink) {
// Initialisation des variables
digitalWrite(ledPin, LOW);
isLocate = true;
repetition = 0;
timer = millis();
} else if (isLocate) {
// Calcule du temps
uint32_t elapsed = millis() - timer;
if (elapsed > BLINK_FREQ) {
repetition++;
if (repetition == BLINK_REP) {
// On a atteint le nombre de clignotements
isLocate = false;
digitalWrite(ledPin, HIGH);
} else {
// On fait clignoter la led
digitalWrite(ledPin, !digitalRead(ledPin));
timer = millis();
}
}
}
}

void setVolume(uint8_t vol) {
volume_level = vol;
Serial.printf("Setting volume to %d\n", volume_level);
player.setVolume(volume_level);
sendPacket(volume_level);
}

void sendNack() {
sendPacket(RESPONSE_NOK);
}

void sendPacket(const char content) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(const char content[]) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(int content) {
char value[4];
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(itoa(content, value, 10));
udp.endPacket();
}

void initCmdServer() {
// Démarrage du serveur TCP
udp.begin(CMD_PORT);
Serial.printf("Ecoute UDP sur le port %d\n", CMD_PORT);
}

void initLocateLed() {
pinMode(ledPin, OUTPUT);
digitalWrite(ledPin, HIGH);
}
</source>
L'ESP est maintenant capable de :
* monter / baisser le volume ;
* de faire un reset du lecteur MP3 (en cas de problème)
* de faire clignoter sa led pour être localisé facilement.

= Enceinte armbian =
Même objectif mais cette fois-ci avec Rygel, un lecteur DLNA.
==Installation ==
Le système:
<pre>
# apt-get update
</pre>
Le lecteur rygel:
<pre>
# apt-get -y install rygel-playbin
</pre>
Les différents plugins. Tout d'abord, récupérer les plugins en fonctions de la distribution:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | awk -F ' - ' '{print $1}')
</pre>
Ensuite on procéde à l'installation:
<pre>
# apt-get install ${plugins}
</pre>

== Création du fichier de service ==
Il suffit de créer le fichier ''/etc/systemd/system/rygel.service'':
<pre>
[Unit]
Description=Rygel service
After=network-online.target

[Service]
Type=simple
UMask=007
ExecStart=/usr/bin/rygel -g 5
Restart=on-failure

# Configures the time to wait before service is stopped forcefully.
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
On peut lancer le service et l'activer au démarrage
<pre>
# systemctl start rygel
# systemctl enable rygel
</pre>
== Désactivation des logs ==
Comme l'enceinte n'est pas à proprement parler un serveur exécutant un service critique, on peut désactiver le système de logging pour économiser la durée de vie de la carte SD:
<pre>
# systemctl stop rsyslog
# systemctl disable rsyslog
</pre>
== Ajustement du volume ==
Il faut maintenant mettre le volume au maximum coté Pi avec le mixer ALSA [https://fr.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture wikipedia] :
<pre>
# alsamixer
</pre>
[[Fichier:alsamixer armbian.png|centré]]
== Changement de la carte son par défaut ==
Une fois la carte son USB installée, il suffit d'utiliser la commande suivante pour voir son identifiant:
<pre>
# aplay -l
**** List of PLAYBACK Hardware Devices ****
card 0: sun4icodec [sun4i-codec], device 0: CDC PCM Codec-0 []
Subdevices: 1/1
Subdevice #0: subdevice #0
card 1: Device [USB Audio Device], device 0: USB Audio [USB Audio]
Subdevices: 0/1
Subdevice #0: subdevice #0
</pre>
La carte son avec l'ID ''0'' est celle intégrée au PI, celle avec l'ID ''1'' est la carte USB.
Pour dire à ALSA que c'est la carte avec l'ID ''1'' que l'on veut par défaut, il suffit de créer le fichier ''/etc/asound.conf'' avec les lignes suivantes:
<pre>
defaults.pcm.card 1
defaults.ctl.card 1
</pre>
La configuration est appliquée après un redémarrage !

== WiringPI==
===Installation===
Pour le Banana Pi M1:
<pre>
# cd /opt
# git clone https://github.com/LeMaker/WiringLMK.git
# cd WiringLMK
# chmod +x ./build
# ./build
</pre>
Pour le Raspberry Pi 2:
<pre>
# apt install -y wiringpi
</pre>

=== Utilisation===
Pour la lecture des états
<pre>
# gpio readall
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| | | 3.3v | | | 1 || 2 | | | 5v | | |
| 2 | 8 | SDA.1 | ALT5 | 0 | 3 || 4 | | | 5V | | |
| 3 | 9 | SCL.1 | ALT5 | 0 | 5 || 6 | | | 0v | | |
| 4 | 7 | GPIO. 7 | IN | 0 | 7 || 8 | 1 | ALT2 | TxD | 15 | 14 |
| | | 0v | | | 9 || 10 | 0 | IN | RxD | 16 | 15 |
| 17 | 0 | GPIO. 0 | IN | 0 | 11 || 12 | 0 | IN | GPIO. 1 | 1 | 18 |
| 27 | 2 | GPIO. 2 | IN | 0 | 13 || 14 | | | 0v | | |
| 22 | 3 | GPIO. 3 | IN | 0 | 15 || 16 | 0 | IN | GPIO. 4 | 4 | 23 |
| | | 3.3v | | | 17 || 18 | 0 | IN | GPIO. 5 | 5 | 24 |
| 10 | 12 | MOSI | ALT5 | 0 | 19 || 20 | | | 0v | | |
| 9 | 13 | MISO | ALT5 | 0 | 21 || 22 | 0 | IN | GPIO. 6 | 6 | 25 |
| 11 | 14 | SCLK | ALT5 | 0 | 23 || 24 | 0 | ALT5 | CE0 | 10 | 8 |
| | | 0v | | | 25 || 26 | 0 | ALT5 | CE1 | 11 | 7 |
| 0 | 30 | SDA.0 | IN | 1 | 27 || 28 | 1 | IN | SCL.0 | 31 | 1 |
| 5 | 21 | GPIO.21 | IN | 0 | 29 || 30 | | | 0v | | |
| 6 | 22 | GPIO.22 | ALT4 | 0 | 31 || 32 | 0 | ALT4 | GPIO.26 | 26 | 12 |
| 13 | 23 | GPIO.23 | IN | 0 | 33 || 34 | | | 0v | | |
| 19 | 24 | GPIO.24 | IN | 0 | 35 || 36 | 0 | IN | GPIO.27 | 27 | 16 |
| 26 | 25 | GPIO.25 | IN | 0 | 37 || 38 | 0 | IN | GPIO.28 | 28 | 20 |
| | | 0v | | | 39 || 40 | 0 | IN | GPIO.29 | 29 | 21 |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
</pre>
Ou d'un état:
<pre>
# gpio read 1
0
</pre>
Changement d'état:
<pre>
# gpio -1 write 8 0
</pre>

== Détection de musique ==
Il est possible de détecter si de la musique est en train d'être jouée sur le PI grâce à la commande suivante:
<pre>
# cat /proc/asound/card*/pcm*/sub*/status | grep RUNNING | wc -l
</pre>
Si cette commande renvoie ''1'' cela veut dire que ''state: RUNNING'' est présent dans un des fichiers d'une des cartes son.

Cette commande peu permettre de piloter un amplificateur au travers d'un relais piloté par une GPIO...

== Ajout du bluetooth ==
=== Paramétrage de la carte===
Il faut d'abord installer blueZ:
<pre>
# apt install -y bluez bluez-tools bluealsa
</pre>
Il faut créer le fichier ''/etc/bluetooth/audio.conf'':
<pre>
[General]
Enable=Source,Sink,Media,Socket
</pre>
éditez le fichier ''/etc/bluetooth/main.conf'' pour modifier les lignes suivantes:
<pre>
...
Class = 0x00041C
...
DiscoverableTimeout = 0
...
PairableTimeout = 0
...
</pre>
Il faut ensuite redémarrer le service ''bluetooth'' pour appairer le téléphone:
<pre>
# systemctl restart bluetooth
</pre>
=== Déclaration de services===
Avant d'aller plus loin, nous allons enregistrer deux commandes en tant que service système:
* ''bluealsa -p a2dp-sink &'' : qui permet de déclarer le PI comme point de terminaison A2DP (musique);
* ''bluealsa-aplay 00:00:00:00:00:00'' : qui permet de laisser passer la musique sur la carte son par défaut.
Pour cela nous allons utiliser la même technique que pour Rygel (plus haut):
* Dans le fichier ''/etc/systemd/system/blue-a2dp.service'':
<pre>
[Unit]
Description=Alsa A2DP service
After=bluetooth.target

[Service]
ExecStart=/usr/bin/bluealsa -p a2dp-sink &
Restart=on-failure
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
* Dans le fichier ''/etc/systemd/system/blue-aplay.service'':
<pre>
[Unit]
Description=Alsa Aplay authorization service
After=bluetooth.target

[Service]
ExecStart=/usr/bin/bluealsa-aplay 00:00:00:00:00:00 &
Restart=on-failure
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
Il ne reste plus qu'à enregistrer les services:
<pre>
# systemctl start blue-a2dp.service
# systemctl start blue-aplay.service
# systemctl enable blue-aplay.service
# systemctl enable blue-a2dp.service
</pre>
=== Appairage ===
Il faut lancer l'utilitaire ''bluetoothctl'':
<pre>
# bluetoothctl
Agent registered
[bluetooth]#
[CHG] Device 0C:2C:54:1B:A3:A9 Connected: yes
[tala_phone]#
</pre>

Iot speaker

2019-07-19T17:12:09Z

Tala : /* Ajout du bluetooth */

=Projet=
{|class="wikitable" width="100%"
|-valign=top
! Objectif !! Les acteurs !! Compétences !! Matériel
|-valign=top
||
Construire des enceintes sans-fils (sauf le courant) actives connectées capables de travailler en "groupe"
||
*[[User:Tala | Tala]]
*[[User:Nigdor |Nigdor]]
*[[User:Prandar |Prandar]]
||
*électronique
*C++ (microcontrôleur)
||
* microcontrôleur (esp8266)
* amplificateur audio (XPT8871, PAM8403, ...)
* décodeur MP3 (VS1053B)
* potentiomètre digital (X9C103S)
|}

= Choix de l'amplificateur =
A faire:
*Expliquer la différence entre classe AB et D (qualité sonore vs. éco énergie)
*Faire un tableau récapitulatif des caractéristiques des amplis:
** mono / stéréo / les deux
** tension de fonctionnement / consommation (5v, 12v, 24v, etc...)
** puissance (5w, 20w, 30w, etc...)
** impédance de sortie (2 x 4Ω, 1 x 8Ω, etc...)
** réponse fréquentielle ;
** résistance aux courts-circuits ;
** bruit pop (quand pas de musique);
** besoin d'un dissipateur ou non (effet joule à prévoir...)
** lien vers la documentation si besoin d'info(eg. pour le [https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932])
** le plus important : le ressenti !
==Classe AB==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
TDA7297
|align=center|
[[Fichier:TDA7297.png|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 15W
|align=center|
2A (peak)
|align=center|
6 - 18 V
|align=center|
OUI
|align=center|
Avec µControlleur<br>(p. 3/4)
|align=center|
Obligatoire
|align=center|
[http://www.st.com/content/ccc/resource/technical/document/datasheet/a3/eb/9b/59/dd/26/4a/27/CD00001048.pdf/files/CD00001048.pdf/jcr:content/translations/en.CD00001048.pdf TDA7297]
|align=left|
Super amplification sans distorsion !
<br>
Forte dissipation thermique à pleine puissance :
* 33W d'après la doc;
* vraiment très (trop) fort !
|}
</div>

==Classe D==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
XH-M531 (YDA138)
|align=center|
[[Fichier:XH-M531.jpg|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 10 W<br>
2 x 20 W
|align=center|
8 Ω<br>
4 Ω
|align=center|
12 - 15V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.ksp-electronics.com/product_files/8eeedc66ea8fbcdf2e74294037c2f389 YDA138]
|align=center|
|-valign="top"
|align=center|
PAM8403
|align=center|
[[Fichier:PAM8403.jpg|centré|100px]]
|align=center|
Stéréo
|align=center|
3W(*2 ?)
|align=center|
4 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
Reduit mais présent
|align=center|
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8403.pdf PAM8403]
|align=center|
|-valign="top"
|align=center|
PAM8610
|align=center|
[[Fichier:PAM8610.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 10 W
|align=center|
8 Ω
|align=center|
7 - 15 V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8610.pdf PAM8610]
|align=center|
|-valign="top"
|align=center|
XPT8871
|align=center|
[[Fichier:XPT8871.jpg|centré|120px]]
|align=center|
Mono
|align=center|
3.5w
<br>
5w
|align=center|
3 Ω
<br>
2 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[[Media:XPT8871.pdf|XPT8871]]
|align=left|
*Bien pour la voix, pas top pour la musique
|-valign="top"
|align=center|
TDA8932
|align=center|
[[Fichier:TDA8932.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2*15W
|align=center|
4 Ω
|align=center|
Entre 10 V et 36 V (Rechercher quel est le plus optimal)
|align=center|
OUI
|align=center|
NON
|align=center|

|align=center|
[https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932]
|align=center|
|-valign="top"
|align=center|
TPA3110
|align=center|
[[Fichier:TPA3110.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
15W/ch
|align=center|
8 Ω
|align=center|
16 V
|align=center|
OUI
|align=center|
NON
|align=center|
OUI
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3110d2.pdf TPA3110]
|align=left|
*Amplification moyenne
*Basses creuses
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3116
|align=center|
[[Fichier:TPA3116.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 50W<br>
2 x 15W
|align=center|
4 Ω<br>
8 Ω
|align=center|
21 V<br>
15 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI<br>
NON
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3116d2.pdf TPA3116]
|align=left|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3118
|align=center|
[[Fichier:TPA3118.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 30W
|align=center|
8 Ω
|align=center|
12 - 24 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI
|align=left|
[http://www.ti.com/lit/ds/symlink/tpa3118d2.pdf TPA3118]
|align=center|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|}
</div>

= Potentiomètre digital =
A faire

= Décodeur MP3 =
==Présentation==
Le décodeur MP3 choisi est le VS1053

[[Fichier:vs1053_board.jpg|centré|200px]]

Ce décodeur offre une interface SPI et permet de lire ainsi que d'enregistrer des fichiers aux formats :
* lecture :
**MP3 ;
**Ogg Vorbis (libre de droit) ;
**PCM;
**WAV;
* enregistrement :
**Ogg Vorbis(libre de droit) ;

==Documentation technique==
Voici la [[:Media:vs1053_doc.pdf|documentation du VS1053]], pour ceux qui voudraient écrire une librairie C++ !

== Schéma ==
Les tests ont été réalisés avec un WemOS D1 mini (ESP8266) :
<div align="center">
{|class="wikitable" width="85%"
! ESP8266 !! VS1053 !! Connections
|-valign=top
||
[[Fichier:wemos_D1_R2_mini_diagram.png|centré|470px]]
||
[[Fichier:vs1053_board_diagram.png|centré|300px]]
|align="center"|
{|class="wikitable"
! ESP8266 !! VS1053
|-
|align="center"| D0
|align="center"| XDCS
|-
|align="center"| D1
|align="center"| XoS (Cable Select)
|-
|align="center"| D3
|align="center"| DREQ
|-
|align="center"| D5
|align="center"| SCK (Serial ClocK)
|-
|align="center"| D6
|align="center"| MISO (Master In Slave Out)
|-
|align="center"| D7
|align="center"| MOSI (Master Out Slave In)
|-
|align="center"| RST
|align="center"| XRST
|-
|align="center"| 5V
|align="center"| 5V
|-
|align="center"| G
|align="center"| DGND
|}
|}
</div>
Vous devriez avoir quelque chose comme ça :

[[Fichier:wemos_D1_vs1053_diagram.jpg|centré|400px]]

== Programmation ==
Tout d'abord un grand merci à [https://github.com/baldram/ESP_VS1053_Library ''baldram''] pour sa [[Media:ESP_VS1053_Library.zip|librairie]] que nous allons utiliser !

Le plus simple est de regarder l'exemple ''SimpleMP3Player'' fourni avec la librairie :
<source lang="c">
// La fameuse librairie de baldram
#include <VS1053.h>
// Un MP3 au format binaire dans un tableau (le fichier est livré avec la librairie)
#include <helloMp3.h>
// Définition des port SPI utilisé (ici pour l'ESP8266)
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
// Définition du volume
#define VOLUME 80 // volume level 0-100
// Création de l'objet VS1053
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);

void setup () {
// Démarrage du SPI
SPI.begin();
// démarrage du VS1053
player.begin();
// Ligne nécessaire pour certain lecteur
player.switchToMp3Mode();
player.setVolume(VOLUME);
}

void loop() {
// On joue le MP3 dans le tableau
player.playChunk(helloMp3, sizeof(helloMp3));
// On attend 3 secondes
delay(3000);
}
</source>
Pour que cet exemple fonctionne, il faut soit copier le contenu de ''HelloMp3.h'' dans le fichier exemple, soit copier le fichier dans le répertoire de la librairie dans votre dossier ''Arduino''.

Une fois la compilation terminée, vous devriez entendre ''du bruit'' sortir du VS1053 !

= Flux musical =
La communication se fera en générant un flux entre le programme (PC) et l'enceinte (ESP8266). Ce flux, pour des raisons de simplicité, se fera en TCP car ce protocole gère les retransmissions, les tampons d'entrée / sortie, etc...

A terme, une application temps réel comme la musique mériterait de passer sur de l'UDP. Surtout que, si l'on souhaite utiliser du [https://www.tala-informatique.fr/wiki/index.php/Esp8266_udp_server multicast], pour parler à un groupe d'enceintes, on ne peut le faire qu'en UDP !
== Envoi : serveur en PHP ==
La partie serveur prend un fichier, ici un MP3, lit un morceau du fichier et l'envoi à l'enceinte à travers une socket TCP. Deux paramètres sont à prendre en compte :
*le temps d'attente entre chaque envoi;
*la taille d'un morceau;
Ces paramètres nécessiteront certainement un temps d'ajustement qui sera en fonction de la latence, la congestion du réseau, les capacités des puces impliquées (ici l'ESP8266), etc...
{|style="width:650px" align="center"
|
[[Fichier:warning-icon.png|centré|60px]]
|valign="top" align="justify"|
Les extraits de code qui vont suivre respectent vaguement les préceptes, au combien importants, de la programmation orientée objet et sont fournis à titre indicatif dans l'unique but de démontrer la faisabilité d'un tel projet ! Voici [[:Media:Iot_Speaker.zip | l'archive]] qui contient le code exposé ci-dessous.
|}
=== MusicSender ===
Voici le contenu du fichier ''MusicSender.class.php'' :
<source lang="php">
<?php

class MusicSender
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5045;

// Le temps d'attente en microsecondes entre chaque paquets
private static $SLEEP_INTERVAL = 2500;

// La taille de chacun des paquets
private static $CHUNK_BUFFER = 32768;

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Envoie le MP3 à l'enceinte
*
* @param string $mp3File
* @return boolean
*/
public function play($mp3File)
{
if (is_file($mp3File)) {
// Ouverture du fichier en lecture binaire
$file = fopen($mp3File, 'rb');
if ($file === FALSE) {
echo "Fail reading file " . $file . "\n";
return FALSE;
}
// Ouverture de la socket
$socket = $this->openSocket();
// Tant qu'on est pas à la fin du fichier
while (! feof($file)) {
// Envoie d'un "morceau" de taille CHUNK_BUFFER à l'enceinte
if (@socket_write($this->socket, fread($file, self::$CHUNK_BUFFER), self::$CHUNK_BUFFER) === FALSE) {
// Problème de socket (fermeture, déconnexion, etc...)
return FALSE;
}
usleep(self::$SLEEP_INTERVAL);
}
// Fermeture de la socket
$this->closeSocket();
// Fermeture du fichier
fclose($file);
return TRUE;
}
echo $file." does not exists !\n";
return FALSE;
}

/**
* Lit tous les mp3 présents dans le dossier
*
* @param string $dir
*/
public function readFolder($dir)
{
if (is_dir($dir)) {
// On récupére les fichiers sans les 2 premiers '.' et '..'
$files = array_slice(scandir($dir), 2);
foreach ($files as $file) {
// On créé le chemin absolu
$mp3File = $dir . DIRECTORY_SEPARATOR . $file;
// On test l'extension
if (pathinfo($file)["extension"] == "mp3") {
$this->play($mp3File);
}
}
return true;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) == FALSE) {
echo "socket_create_listen() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
if (socket_connect($this->socket, $this->ip, self::$PORT) == FALSE) {
echo "socket_bind() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
=== Launch.php ===
On créé un fichier ''Launch.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicSender.class.php';

$esp_ip = "192.168.1.200";

$dir = "!!chemin_vers_des_fichiers_mp3!!";

$sender = new MusicSender($esp_ip);

$sender->readFolder($dir);
</source>

== Réception : ESP8266 ==
{|style="width:650px" align="center"
|
[[Fichier:Warning manual.jpg|centré|300px]]
|valign="top" align="justify"|
Soyez sûr de comprendre la section sur [https://www.tala-informatique.fr/wiki/index.php/Arduino_sketch_writing| comment écrire un sketch] avant de poursuivre. Le code ci-dessous fait référence à des parties bien spécifiques, détaillées et expliquées dans la section suscitée.
|}
=== Partie WiFi ===
La première étape consiste à raccorder notre ''ESP'' au réseau WiFi !
<source lang="c">
#include <ESP8266WiFi.h>
#include <WiFiClient.h>

// WiFi Parameters //
const char ssid[] = "cfcasa";
const char password[] = "***********";
IPAddress ip(192, 168, 1, 200);
IPAddress gw(192, 168, 1, 254);
IPAddress mask(255, 255, 252, 0);

void setup() {
// on démarre le port série
Serial.begin(115200);
// On attend "un peu" que le buffer soit prêt
delay(10);
// On démarre le WiFi
initWiFi();
}

void loop() {
}

void initWiFi() {
// On efface la configuration précédente
WiFi.disconnect(true);
Serial.printf("\nConnexion a %s", ssid);
// Initialisation de la connection
WiFi.config(ip, gw, mask, gw);
WiFi.begin(ssid, password);
// Test pour déterminer quand la connection est prete
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(".");
}
// Affichage des informations
Serial.printf(" connecté\nAdresse IP: %s\n", WiFi.localIP().toString().c_str());
}
</source>
=== Lecteur MP3 ===
Vient ensuite la partie du lecteur MP3. Dans la partie des imports, ajoutez la ligne suivante :
<source lang="c">
#include <VS1053.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Parameters //
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
#define VOLUME 70 // volume level 0-100
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);
uint8_t volume_level = VOLUME;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le shield MP3
initMP3();
</source>
A la suite, on insère la fonction suivante :
<source lang="c">
void initMP3() {
SPI.begin();
// Démarrage du lecteur MP3
player.begin();
player.switchToMp3Mode();
player.setVolume(volume_level);
}
</source>
=== Récupération du stream MP3 ===
On va maintenant récupérer le flux envoyé depuis le serveur. Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Server parameters //
const uint16_t MP3_PORT = 5045;
WiFiServer server(MP3_PORT);
const uint16_t BUFFER_SIZE = 16384;
//const uint16_t BUFFER_SIZE = 32768;
byte buffer[BUFFER_SIZE + 1];
uint16_t byteRead = 0;
bool isBufferReady = false;
WiFiClient client;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur TCP
initMp3Server();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
void initMp3Server() {
// Démarrage du serveur TCP
server.begin();
Serial.printf("Ecoute TCP sur le port %d\n", MP3_PORT);
}

void readMp3() {
// Un client est connecté
if (client) {
// Si le client est toujours connecté...
if (client.connected()) {
// Tant que l'on reçoit de la musique
while (client.available() > 0) {
// On rempli le buffer avec le contenu du paquet TCP
buffer[byteRead++] = client.read();
// Si le buffer est plein
if (byteRead == BUFFER_SIZE) {
// On previent que le buffer est plein
isBufferReady = true;
// On sort de la boucle
break;
}
}
// Si le buffer est plein
if (isBufferReady) {
// On envoi tout au lecteur MP3
player.playChunk(buffer, byteRead);
// On RAZ le compteur de bytes
byteRead = 0;
}
} else {
// Si le client est déconneté
client = server.available();
// On prévient que le buffer est vide
isBufferReady = false;
// On RAZ le compteur de bytes
byteRead = 0;
Serial.println(F("Client disconnected"));
}
} else {
// On test la présence d'un client
client = server.available();
if (client) {
// Un client est connecté !
Serial.println(F("New client !"));
}
}
}
</source>
Enfin, on ajoute le ligne suivante dans la fonction ''loop()'' :
<source lang="c">
readMp3();
</source>
A ce stade, l'ESP devrait être capable de récupérer le flux et de le jouer !

= Envoi de commandes =
Envoyer de la musique c'est bien, pouvoir régler le volume c'est encore mieux !

La façon la plus simple d'adresser le problème c'est d'utiliser un autre port et, comme les messages sont petits, d'utiliser UDP.
== Partie Serveur ==
Dans la même veine, voici la classe qui permet d'envoyer les commandes :
<source lang="php">
<?php

class MusicHandler
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5046;

// Le port de l'enceinte connectée
private static $RETRIES = 3;

// Liste de commandes
private static $CMD_VOLUME = 'V';

private static $CMD_LOCATE = 'L';

private static $CMD_RESET = 'R';

private static $RESPONSE_NOK = 'N';

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Augmente le volume d'un incrément
*
* @return boolean
*/
public function volumeUp()
{
return $this->sendCommand(self::$CMD_VOLUME . "+");
}

/**
* Baisse le volume d'un incrément
*
* @return boolean
*/
public function volumeDown()
{
return $this->sendCommand(self::$CMD_VOLUME . "-");
}

/**
*
* @return boolean
*/
public function setVolume($volume)
{
if ($volume < 0 || $volume > 100) {
return false;
}
return $this->sendCommand(self::$CMD_VOLUME . $volume);
}

public function getVolume(){
return $this->sendCommand(self::$CMD_VOLUME);
}

/**
*
* @return boolean
*/
public function doReset()
{
return $this->sendCommand(self::$CMD_RESET);
}

public function doLocate(){
return $this->sendCommand(self::$CMD_LOCATE);
}

/**
* Envoie une commande au module
*
* @param string $message
*/
private function sendCommand($message)
{
$result = false;
if ($this->openSocket() !== FALSE) {
if (socket_sendto($this->socket, $message, strlen($message), 0, $this->ip, self::$PORT) !== FALSE) {
$result = $this->readAcknoledge();
}
}
$this->closeSocket();
return $result;
}

/**
* Attend la confirmation de la commande
*
* @return boolean
*/
private function readAcknoledge()
{
$buf = "";
$retries = 0;
while ($retries < self::$RETRIES) {
$byteReceived = socket_recvfrom($this->socket, $buf, 2048, 0, $this->ip, self::$PORT);
if ($byteReceived > 0) {
return $buf != self::$RESPONSE_NOK ? $buf : FALSE;
}
usleep(500000);
$retries ++;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) === FALSE) {
$errorcode = socket_last_error();
$errormsg = socket_strerror($errorcode);
echo ("Couldn't create socket: [$errorcode] $errormsg \n");
return false;
}
return true;
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
On créé un fichier ''Command.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicHandler.class.php';

$esp_ip = "192.168.1.200";

$handler = new MusicHandler($esp_ip);

// Exemple de commandes //
//$result = $handler->volumeUp();
//$result = $handler->getVolume();
//$result = $handler->doReset();
//$result = $handler->setVolume(70);

$result = $handler->doLocate();

echo $result !== FALSE ? "ok : $result\n" : "nok\n";
</source>
== Partie Cliente ==
Dans la partie des imports ajoutez la ligne suivante :
<source lang="c">
#include <WiFiUDP.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// Command Server parameters //
const uint16_t CMD_PORT = 5046;
// L'instance du serveur UDP
WiFiUDP udp;
// Liste de commandes
const char CMD_VOLUME = 'V';
const char CMD_LOCATE = 'L';
const char CMD_RESET = 'R';
const char RESPONSE_NOK[] = "N";

// Localisation parameters
uint8_t ledPin = LED_BUILTIN;
const uint16_t BLINK_FREQ = 500;
const uint8_t BLINK_REP = 60;
uint8_t repetition = 0;
uint32_t timer;
bool isLocate = false;
</source>
A la fin de la fonction setup() nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur UDP
initCmdServer();
// On prépare la led de localisation
initLocateLed();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
bool readCmd() {
if (udp.parsePacket() > 0) {
uint8_t len = udp.available();
char c = udp.read();
if (len == 1) {
if (c == CMD_RESET) {
player.softReset();
sendPacket(CMD_RESET);
return true;
} else if (c == CMD_VOLUME) {
sendPacket(volume_level);
return true;
} else if (c == CMD_LOCATE) {
if (!isLocate) {
locate(true);
sendPacket(CMD_LOCATE);
return true;
}
}
} else if (len == 2) {
char value = udp.read();
if (c == CMD_VOLUME) {
if (value == '+' && volume_level != 100) {
setVolume(volume_level + 1);
} else if (value == '-' && volume_level != 0) {
setVolume(volume_level - 1);
} else {
sendNack();
return false;
}
return true;
}
} else {
if (c == CMD_VOLUME) {
char value[4] = "0";
udp.read(value, 3);
uint8_t vol = atoi(value);
if (vol >= 0 && vol <= 100) {
setVolume(vol);
return true;
}
}
}
sendNack();
return false;
}
// Check if locate needs to be done
locate(false);
}
void locate(bool blink) {
if (blink) {
// Initialisation des variables
digitalWrite(ledPin, LOW);
isLocate = true;
repetition = 0;
timer = millis();
} else if (isLocate) {
// Calcule du temps
uint32_t elapsed = millis() - timer;
if (elapsed > BLINK_FREQ) {
repetition++;
if (repetition == BLINK_REP) {
// On a atteint le nombre de clignotements
isLocate = false;
digitalWrite(ledPin, HIGH);
} else {
// On fait clignoter la led
digitalWrite(ledPin, !digitalRead(ledPin));
timer = millis();
}
}
}
}

void setVolume(uint8_t vol) {
volume_level = vol;
Serial.printf("Setting volume to %d\n", volume_level);
player.setVolume(volume_level);
sendPacket(volume_level);
}

void sendNack() {
sendPacket(RESPONSE_NOK);
}

void sendPacket(const char content) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(const char content[]) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(int content) {
char value[4];
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(itoa(content, value, 10));
udp.endPacket();
}

void initCmdServer() {
// Démarrage du serveur TCP
udp.begin(CMD_PORT);
Serial.printf("Ecoute UDP sur le port %d\n", CMD_PORT);
}

void initLocateLed() {
pinMode(ledPin, OUTPUT);
digitalWrite(ledPin, HIGH);
}
</source>
L'ESP est maintenant capable de :
* monter / baisser le volume ;
* de faire un reset du lecteur MP3 (en cas de problème)
* de faire clignoter sa led pour être localisé facilement.

= Enceinte armbian =
Même objectif mais cette fois-ci avec Rygel, un lecteur DLNA.
==Installation ==
Le système:
<pre>
# apt-get update
</pre>
Le lecteur rygel:
<pre>
# apt-get -y install rygel-playbin
</pre>
Les différents plugins. Tout d'abord, récupérer les plugins en fonctions de la distribution:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | awk -F ' - ' '{print $1}')
</pre>
Ensuite on procéde à l'installation:
<pre>
# apt-get install ${plugins}
</pre>

== Création du fichier de service ==
Il suffit de créer le fichier ''/etc/systemd/system/rygel.service'':
<pre>
[Unit]
Description=Rygel service
After=network-online.target

[Service]
Type=simple
UMask=007
ExecStart=/usr/bin/rygel -g 5
Restart=on-failure

# Configures the time to wait before service is stopped forcefully.
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
On peut lancer le service et l'activer au démarrage
<pre>
# systemctl start rygel
# systemctl enable rygel
</pre>
== Désactivation des logs ==
Comme l'enceinte n'est pas à proprement parler un serveur exécutant un service critique, on peut désactiver le système de logging pour économiser la durée de vie de la carte SD:
<pre>
# systemctl stop rsyslog
# systemctl disable rsyslog
</pre>
== Ajustement du volume ==
Il faut maintenant mettre le volume au maximum coté Pi avec le mixer ALSA [https://fr.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture wikipedia] :
<pre>
# alsamixer
</pre>
[[Fichier:alsamixer armbian.png|centré]]
== Changement de la carte son par défaut ==
Une fois la carte son USB installée, il suffit d'utiliser la commande suivante pour voir son identifiant:
<pre>
# aplay -l
**** List of PLAYBACK Hardware Devices ****
card 0: sun4icodec [sun4i-codec], device 0: CDC PCM Codec-0 []
Subdevices: 1/1
Subdevice #0: subdevice #0
card 1: Device [USB Audio Device], device 0: USB Audio [USB Audio]
Subdevices: 0/1
Subdevice #0: subdevice #0
</pre>
La carte son avec l'ID ''0'' est celle intégrée au PI, celle avec l'ID ''1'' est la carte USB.
Pour dire à ALSA que c'est la carte avec l'ID ''1'' que l'on veut par défaut, il suffit de créer le fichier ''/etc/asound.conf'' avec les lignes suivantes:
<pre>
defaults.pcm.card 1
defaults.ctl.card 1
</pre>
La configuration est appliquée après un redémarrage !

== WiringPI==
===Installation===
Pour le Banana Pi M1:
<pre>
# cd /opt
# git clone https://github.com/LeMaker/WiringLMK.git
# cd WiringLMK
# chmod +x ./build
# ./build
</pre>
Pour le Raspberry Pi 2:
<pre>
# apt install -y wiringpi
</pre>

=== Utilisation===
Pour la lecture des états
<pre>
# gpio readall
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| | | 3.3v | | | 1 || 2 | | | 5v | | |
| 2 | 8 | SDA.1 | ALT5 | 0 | 3 || 4 | | | 5V | | |
| 3 | 9 | SCL.1 | ALT5 | 0 | 5 || 6 | | | 0v | | |
| 4 | 7 | GPIO. 7 | IN | 0 | 7 || 8 | 1 | ALT2 | TxD | 15 | 14 |
| | | 0v | | | 9 || 10 | 0 | IN | RxD | 16 | 15 |
| 17 | 0 | GPIO. 0 | IN | 0 | 11 || 12 | 0 | IN | GPIO. 1 | 1 | 18 |
| 27 | 2 | GPIO. 2 | IN | 0 | 13 || 14 | | | 0v | | |
| 22 | 3 | GPIO. 3 | IN | 0 | 15 || 16 | 0 | IN | GPIO. 4 | 4 | 23 |
| | | 3.3v | | | 17 || 18 | 0 | IN | GPIO. 5 | 5 | 24 |
| 10 | 12 | MOSI | ALT5 | 0 | 19 || 20 | | | 0v | | |
| 9 | 13 | MISO | ALT5 | 0 | 21 || 22 | 0 | IN | GPIO. 6 | 6 | 25 |
| 11 | 14 | SCLK | ALT5 | 0 | 23 || 24 | 0 | ALT5 | CE0 | 10 | 8 |
| | | 0v | | | 25 || 26 | 0 | ALT5 | CE1 | 11 | 7 |
| 0 | 30 | SDA.0 | IN | 1 | 27 || 28 | 1 | IN | SCL.0 | 31 | 1 |
| 5 | 21 | GPIO.21 | IN | 0 | 29 || 30 | | | 0v | | |
| 6 | 22 | GPIO.22 | ALT4 | 0 | 31 || 32 | 0 | ALT4 | GPIO.26 | 26 | 12 |
| 13 | 23 | GPIO.23 | IN | 0 | 33 || 34 | | | 0v | | |
| 19 | 24 | GPIO.24 | IN | 0 | 35 || 36 | 0 | IN | GPIO.27 | 27 | 16 |
| 26 | 25 | GPIO.25 | IN | 0 | 37 || 38 | 0 | IN | GPIO.28 | 28 | 20 |
| | | 0v | | | 39 || 40 | 0 | IN | GPIO.29 | 29 | 21 |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
</pre>
Ou d'un état:
<pre>
# gpio read 1
0
</pre>
Changement d'état:
<pre>
# gpio -1 write 8 0
</pre>

== Détection de musique ==
Il est possible de détecter si de la musique est en train d'être jouée sur le PI grâce à la commande suivante:
<pre>
# cat /proc/asound/card*/pcm*/sub*/status | grep RUNNING | wc -l
</pre>
Si cette commande renvoie ''1'' cela veut dire que ''state: RUNNING'' est présent dans un des fichiers d'une des cartes son.

Cette commande peu permettre de piloter un amplificateur au travers d'un relais piloté par une GPIO...

== Ajout du bluetooth ==
Il faut d'abord installer blueZ:
<pre>
# apt install -y bluez bluez-tools bluealsa
</pre>
Il faut créer le fichier ''/etc/bluetooth/audio.conf'':
<pre>
[General]
Enable=Source,Sink,Media,Socket
</pre>
éditer le fichier ''/etc/bluetooth/main.conf'' pour modifier les lignes suivantes:
<pre>
...
Class = 0x00041C
...
DiscoverableTimeout = 0
...
PairableTimeout = 0
...
</pre>
Il faut ensuite redémarrer le service ''bluetooth'' pour appairer le téléphone:
<pre>
# systemctl restart bluetooth
</pre>
Il faut lancer l'utilitaire ''bluetoothctl'':
<pre>
# bluetoothctl
Agent registered
[bluetooth]#
[CHG] Device 0C:2C:54:1B:A3:A9 Connected: yes
[tala_phone]#
</pre>

Iot speaker

2019-07-19T15:20:12Z

Tala : /* Installation */

=Projet=
{|class="wikitable" width="100%"
|-valign=top
! Objectif !! Les acteurs !! Compétences !! Matériel
|-valign=top
||
Construire des enceintes sans-fils (sauf le courant) actives connectées capables de travailler en "groupe"
||
*[[User:Tala | Tala]]
*[[User:Nigdor |Nigdor]]
*[[User:Prandar |Prandar]]
||
*électronique
*C++ (microcontrôleur)
||
* microcontrôleur (esp8266)
* amplificateur audio (XPT8871, PAM8403, ...)
* décodeur MP3 (VS1053B)
* potentiomètre digital (X9C103S)
|}

= Choix de l'amplificateur =
A faire:
*Expliquer la différence entre classe AB et D (qualité sonore vs. éco énergie)
*Faire un tableau récapitulatif des caractéristiques des amplis:
** mono / stéréo / les deux
** tension de fonctionnement / consommation (5v, 12v, 24v, etc...)
** puissance (5w, 20w, 30w, etc...)
** impédance de sortie (2 x 4Ω, 1 x 8Ω, etc...)
** réponse fréquentielle ;
** résistance aux courts-circuits ;
** bruit pop (quand pas de musique);
** besoin d'un dissipateur ou non (effet joule à prévoir...)
** lien vers la documentation si besoin d'info(eg. pour le [https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932])
** le plus important : le ressenti !
==Classe AB==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
TDA7297
|align=center|
[[Fichier:TDA7297.png|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 15W
|align=center|
2A (peak)
|align=center|
6 - 18 V
|align=center|
OUI
|align=center|
Avec µControlleur<br>(p. 3/4)
|align=center|
Obligatoire
|align=center|
[http://www.st.com/content/ccc/resource/technical/document/datasheet/a3/eb/9b/59/dd/26/4a/27/CD00001048.pdf/files/CD00001048.pdf/jcr:content/translations/en.CD00001048.pdf TDA7297]
|align=left|
Super amplification sans distorsion !
<br>
Forte dissipation thermique à pleine puissance :
* 33W d'après la doc;
* vraiment très (trop) fort !
|}
</div>

==Classe D==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
XH-M531 (YDA138)
|align=center|
[[Fichier:XH-M531.jpg|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 10 W<br>
2 x 20 W
|align=center|
8 Ω<br>
4 Ω
|align=center|
12 - 15V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.ksp-electronics.com/product_files/8eeedc66ea8fbcdf2e74294037c2f389 YDA138]
|align=center|
|-valign="top"
|align=center|
PAM8403
|align=center|
[[Fichier:PAM8403.jpg|centré|100px]]
|align=center|
Stéréo
|align=center|
3W(*2 ?)
|align=center|
4 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
Reduit mais présent
|align=center|
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8403.pdf PAM8403]
|align=center|
|-valign="top"
|align=center|
PAM8610
|align=center|
[[Fichier:PAM8610.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 10 W
|align=center|
8 Ω
|align=center|
7 - 15 V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8610.pdf PAM8610]
|align=center|
|-valign="top"
|align=center|
XPT8871
|align=center|
[[Fichier:XPT8871.jpg|centré|120px]]
|align=center|
Mono
|align=center|
3.5w
<br>
5w
|align=center|
3 Ω
<br>
2 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[[Media:XPT8871.pdf|XPT8871]]
|align=left|
*Bien pour la voix, pas top pour la musique
|-valign="top"
|align=center|
TDA8932
|align=center|
[[Fichier:TDA8932.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2*15W
|align=center|
4 Ω
|align=center|
Entre 10 V et 36 V (Rechercher quel est le plus optimal)
|align=center|
OUI
|align=center|
NON
|align=center|

|align=center|
[https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932]
|align=center|
|-valign="top"
|align=center|
TPA3110
|align=center|
[[Fichier:TPA3110.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
15W/ch
|align=center|
8 Ω
|align=center|
16 V
|align=center|
OUI
|align=center|
NON
|align=center|
OUI
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3110d2.pdf TPA3110]
|align=left|
*Amplification moyenne
*Basses creuses
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3116
|align=center|
[[Fichier:TPA3116.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 50W<br>
2 x 15W
|align=center|
4 Ω<br>
8 Ω
|align=center|
21 V<br>
15 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI<br>
NON
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3116d2.pdf TPA3116]
|align=left|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3118
|align=center|
[[Fichier:TPA3118.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 30W
|align=center|
8 Ω
|align=center|
12 - 24 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI
|align=left|
[http://www.ti.com/lit/ds/symlink/tpa3118d2.pdf TPA3118]
|align=center|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|}
</div>

= Potentiomètre digital =
A faire

= Décodeur MP3 =
==Présentation==
Le décodeur MP3 choisi est le VS1053

[[Fichier:vs1053_board.jpg|centré|200px]]

Ce décodeur offre une interface SPI et permet de lire ainsi que d'enregistrer des fichiers aux formats :
* lecture :
**MP3 ;
**Ogg Vorbis (libre de droit) ;
**PCM;
**WAV;
* enregistrement :
**Ogg Vorbis(libre de droit) ;

==Documentation technique==
Voici la [[:Media:vs1053_doc.pdf|documentation du VS1053]], pour ceux qui voudraient écrire une librairie C++ !

== Schéma ==
Les tests ont été réalisés avec un WemOS D1 mini (ESP8266) :
<div align="center">
{|class="wikitable" width="85%"
! ESP8266 !! VS1053 !! Connections
|-valign=top
||
[[Fichier:wemos_D1_R2_mini_diagram.png|centré|470px]]
||
[[Fichier:vs1053_board_diagram.png|centré|300px]]
|align="center"|
{|class="wikitable"
! ESP8266 !! VS1053
|-
|align="center"| D0
|align="center"| XDCS
|-
|align="center"| D1
|align="center"| XoS (Cable Select)
|-
|align="center"| D3
|align="center"| DREQ
|-
|align="center"| D5
|align="center"| SCK (Serial ClocK)
|-
|align="center"| D6
|align="center"| MISO (Master In Slave Out)
|-
|align="center"| D7
|align="center"| MOSI (Master Out Slave In)
|-
|align="center"| RST
|align="center"| XRST
|-
|align="center"| 5V
|align="center"| 5V
|-
|align="center"| G
|align="center"| DGND
|}
|}
</div>
Vous devriez avoir quelque chose comme ça :

[[Fichier:wemos_D1_vs1053_diagram.jpg|centré|400px]]

== Programmation ==
Tout d'abord un grand merci à [https://github.com/baldram/ESP_VS1053_Library ''baldram''] pour sa [[Media:ESP_VS1053_Library.zip|librairie]] que nous allons utiliser !

Le plus simple est de regarder l'exemple ''SimpleMP3Player'' fourni avec la librairie :
<source lang="c">
// La fameuse librairie de baldram
#include <VS1053.h>
// Un MP3 au format binaire dans un tableau (le fichier est livré avec la librairie)
#include <helloMp3.h>
// Définition des port SPI utilisé (ici pour l'ESP8266)
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
// Définition du volume
#define VOLUME 80 // volume level 0-100
// Création de l'objet VS1053
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);

void setup () {
// Démarrage du SPI
SPI.begin();
// démarrage du VS1053
player.begin();
// Ligne nécessaire pour certain lecteur
player.switchToMp3Mode();
player.setVolume(VOLUME);
}

void loop() {
// On joue le MP3 dans le tableau
player.playChunk(helloMp3, sizeof(helloMp3));
// On attend 3 secondes
delay(3000);
}
</source>
Pour que cet exemple fonctionne, il faut soit copier le contenu de ''HelloMp3.h'' dans le fichier exemple, soit copier le fichier dans le répertoire de la librairie dans votre dossier ''Arduino''.

Une fois la compilation terminée, vous devriez entendre ''du bruit'' sortir du VS1053 !

= Flux musical =
La communication se fera en générant un flux entre le programme (PC) et l'enceinte (ESP8266). Ce flux, pour des raisons de simplicité, se fera en TCP car ce protocole gère les retransmissions, les tampons d'entrée / sortie, etc...

A terme, une application temps réel comme la musique mériterait de passer sur de l'UDP. Surtout que, si l'on souhaite utiliser du [https://www.tala-informatique.fr/wiki/index.php/Esp8266_udp_server multicast], pour parler à un groupe d'enceintes, on ne peut le faire qu'en UDP !
== Envoi : serveur en PHP ==
La partie serveur prend un fichier, ici un MP3, lit un morceau du fichier et l'envoi à l'enceinte à travers une socket TCP. Deux paramètres sont à prendre en compte :
*le temps d'attente entre chaque envoi;
*la taille d'un morceau;
Ces paramètres nécessiteront certainement un temps d'ajustement qui sera en fonction de la latence, la congestion du réseau, les capacités des puces impliquées (ici l'ESP8266), etc...
{|style="width:650px" align="center"
|
[[Fichier:warning-icon.png|centré|60px]]
|valign="top" align="justify"|
Les extraits de code qui vont suivre respectent vaguement les préceptes, au combien importants, de la programmation orientée objet et sont fournis à titre indicatif dans l'unique but de démontrer la faisabilité d'un tel projet ! Voici [[:Media:Iot_Speaker.zip | l'archive]] qui contient le code exposé ci-dessous.
|}
=== MusicSender ===
Voici le contenu du fichier ''MusicSender.class.php'' :
<source lang="php">
<?php

class MusicSender
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5045;

// Le temps d'attente en microsecondes entre chaque paquets
private static $SLEEP_INTERVAL = 2500;

// La taille de chacun des paquets
private static $CHUNK_BUFFER = 32768;

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Envoie le MP3 à l'enceinte
*
* @param string $mp3File
* @return boolean
*/
public function play($mp3File)
{
if (is_file($mp3File)) {
// Ouverture du fichier en lecture binaire
$file = fopen($mp3File, 'rb');
if ($file === FALSE) {
echo "Fail reading file " . $file . "\n";
return FALSE;
}
// Ouverture de la socket
$socket = $this->openSocket();
// Tant qu'on est pas à la fin du fichier
while (! feof($file)) {
// Envoie d'un "morceau" de taille CHUNK_BUFFER à l'enceinte
if (@socket_write($this->socket, fread($file, self::$CHUNK_BUFFER), self::$CHUNK_BUFFER) === FALSE) {
// Problème de socket (fermeture, déconnexion, etc...)
return FALSE;
}
usleep(self::$SLEEP_INTERVAL);
}
// Fermeture de la socket
$this->closeSocket();
// Fermeture du fichier
fclose($file);
return TRUE;
}
echo $file." does not exists !\n";
return FALSE;
}

/**
* Lit tous les mp3 présents dans le dossier
*
* @param string $dir
*/
public function readFolder($dir)
{
if (is_dir($dir)) {
// On récupére les fichiers sans les 2 premiers '.' et '..'
$files = array_slice(scandir($dir), 2);
foreach ($files as $file) {
// On créé le chemin absolu
$mp3File = $dir . DIRECTORY_SEPARATOR . $file;
// On test l'extension
if (pathinfo($file)["extension"] == "mp3") {
$this->play($mp3File);
}
}
return true;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) == FALSE) {
echo "socket_create_listen() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
if (socket_connect($this->socket, $this->ip, self::$PORT) == FALSE) {
echo "socket_bind() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
=== Launch.php ===
On créé un fichier ''Launch.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicSender.class.php';

$esp_ip = "192.168.1.200";

$dir = "!!chemin_vers_des_fichiers_mp3!!";

$sender = new MusicSender($esp_ip);

$sender->readFolder($dir);
</source>

== Réception : ESP8266 ==
{|style="width:650px" align="center"
|
[[Fichier:Warning manual.jpg|centré|300px]]
|valign="top" align="justify"|
Soyez sûr de comprendre la section sur [https://www.tala-informatique.fr/wiki/index.php/Arduino_sketch_writing| comment écrire un sketch] avant de poursuivre. Le code ci-dessous fait référence à des parties bien spécifiques, détaillées et expliquées dans la section suscitée.
|}
=== Partie WiFi ===
La première étape consiste à raccorder notre ''ESP'' au réseau WiFi !
<source lang="c">
#include <ESP8266WiFi.h>
#include <WiFiClient.h>

// WiFi Parameters //
const char ssid[] = "cfcasa";
const char password[] = "***********";
IPAddress ip(192, 168, 1, 200);
IPAddress gw(192, 168, 1, 254);
IPAddress mask(255, 255, 252, 0);

void setup() {
// on démarre le port série
Serial.begin(115200);
// On attend "un peu" que le buffer soit prêt
delay(10);
// On démarre le WiFi
initWiFi();
}

void loop() {
}

void initWiFi() {
// On efface la configuration précédente
WiFi.disconnect(true);
Serial.printf("\nConnexion a %s", ssid);
// Initialisation de la connection
WiFi.config(ip, gw, mask, gw);
WiFi.begin(ssid, password);
// Test pour déterminer quand la connection est prete
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(".");
}
// Affichage des informations
Serial.printf(" connecté\nAdresse IP: %s\n", WiFi.localIP().toString().c_str());
}
</source>
=== Lecteur MP3 ===
Vient ensuite la partie du lecteur MP3. Dans la partie des imports, ajoutez la ligne suivante :
<source lang="c">
#include <VS1053.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Parameters //
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
#define VOLUME 70 // volume level 0-100
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);
uint8_t volume_level = VOLUME;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le shield MP3
initMP3();
</source>
A la suite, on insère la fonction suivante :
<source lang="c">
void initMP3() {
SPI.begin();
// Démarrage du lecteur MP3
player.begin();
player.switchToMp3Mode();
player.setVolume(volume_level);
}
</source>
=== Récupération du stream MP3 ===
On va maintenant récupérer le flux envoyé depuis le serveur. Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Server parameters //
const uint16_t MP3_PORT = 5045;
WiFiServer server(MP3_PORT);
const uint16_t BUFFER_SIZE = 16384;
//const uint16_t BUFFER_SIZE = 32768;
byte buffer[BUFFER_SIZE + 1];
uint16_t byteRead = 0;
bool isBufferReady = false;
WiFiClient client;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur TCP
initMp3Server();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
void initMp3Server() {
// Démarrage du serveur TCP
server.begin();
Serial.printf("Ecoute TCP sur le port %d\n", MP3_PORT);
}

void readMp3() {
// Un client est connecté
if (client) {
// Si le client est toujours connecté...
if (client.connected()) {
// Tant que l'on reçoit de la musique
while (client.available() > 0) {
// On rempli le buffer avec le contenu du paquet TCP
buffer[byteRead++] = client.read();
// Si le buffer est plein
if (byteRead == BUFFER_SIZE) {
// On previent que le buffer est plein
isBufferReady = true;
// On sort de la boucle
break;
}
}
// Si le buffer est plein
if (isBufferReady) {
// On envoi tout au lecteur MP3
player.playChunk(buffer, byteRead);
// On RAZ le compteur de bytes
byteRead = 0;
}
} else {
// Si le client est déconneté
client = server.available();
// On prévient que le buffer est vide
isBufferReady = false;
// On RAZ le compteur de bytes
byteRead = 0;
Serial.println(F("Client disconnected"));
}
} else {
// On test la présence d'un client
client = server.available();
if (client) {
// Un client est connecté !
Serial.println(F("New client !"));
}
}
}
</source>
Enfin, on ajoute le ligne suivante dans la fonction ''loop()'' :
<source lang="c">
readMp3();
</source>
A ce stade, l'ESP devrait être capable de récupérer le flux et de le jouer !

= Envoi de commandes =
Envoyer de la musique c'est bien, pouvoir régler le volume c'est encore mieux !

La façon la plus simple d'adresser le problème c'est d'utiliser un autre port et, comme les messages sont petits, d'utiliser UDP.
== Partie Serveur ==
Dans la même veine, voici la classe qui permet d'envoyer les commandes :
<source lang="php">
<?php

class MusicHandler
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5046;

// Le port de l'enceinte connectée
private static $RETRIES = 3;

// Liste de commandes
private static $CMD_VOLUME = 'V';

private static $CMD_LOCATE = 'L';

private static $CMD_RESET = 'R';

private static $RESPONSE_NOK = 'N';

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Augmente le volume d'un incrément
*
* @return boolean
*/
public function volumeUp()
{
return $this->sendCommand(self::$CMD_VOLUME . "+");
}

/**
* Baisse le volume d'un incrément
*
* @return boolean
*/
public function volumeDown()
{
return $this->sendCommand(self::$CMD_VOLUME . "-");
}

/**
*
* @return boolean
*/
public function setVolume($volume)
{
if ($volume < 0 || $volume > 100) {
return false;
}
return $this->sendCommand(self::$CMD_VOLUME . $volume);
}

public function getVolume(){
return $this->sendCommand(self::$CMD_VOLUME);
}

/**
*
* @return boolean
*/
public function doReset()
{
return $this->sendCommand(self::$CMD_RESET);
}

public function doLocate(){
return $this->sendCommand(self::$CMD_LOCATE);
}

/**
* Envoie une commande au module
*
* @param string $message
*/
private function sendCommand($message)
{
$result = false;
if ($this->openSocket() !== FALSE) {
if (socket_sendto($this->socket, $message, strlen($message), 0, $this->ip, self::$PORT) !== FALSE) {
$result = $this->readAcknoledge();
}
}
$this->closeSocket();
return $result;
}

/**
* Attend la confirmation de la commande
*
* @return boolean
*/
private function readAcknoledge()
{
$buf = "";
$retries = 0;
while ($retries < self::$RETRIES) {
$byteReceived = socket_recvfrom($this->socket, $buf, 2048, 0, $this->ip, self::$PORT);
if ($byteReceived > 0) {
return $buf != self::$RESPONSE_NOK ? $buf : FALSE;
}
usleep(500000);
$retries ++;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) === FALSE) {
$errorcode = socket_last_error();
$errormsg = socket_strerror($errorcode);
echo ("Couldn't create socket: [$errorcode] $errormsg \n");
return false;
}
return true;
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
On créé un fichier ''Command.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicHandler.class.php';

$esp_ip = "192.168.1.200";

$handler = new MusicHandler($esp_ip);

// Exemple de commandes //
//$result = $handler->volumeUp();
//$result = $handler->getVolume();
//$result = $handler->doReset();
//$result = $handler->setVolume(70);

$result = $handler->doLocate();

echo $result !== FALSE ? "ok : $result\n" : "nok\n";
</source>
== Partie Cliente ==
Dans la partie des imports ajoutez la ligne suivante :
<source lang="c">
#include <WiFiUDP.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// Command Server parameters //
const uint16_t CMD_PORT = 5046;
// L'instance du serveur UDP
WiFiUDP udp;
// Liste de commandes
const char CMD_VOLUME = 'V';
const char CMD_LOCATE = 'L';
const char CMD_RESET = 'R';
const char RESPONSE_NOK[] = "N";

// Localisation parameters
uint8_t ledPin = LED_BUILTIN;
const uint16_t BLINK_FREQ = 500;
const uint8_t BLINK_REP = 60;
uint8_t repetition = 0;
uint32_t timer;
bool isLocate = false;
</source>
A la fin de la fonction setup() nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur UDP
initCmdServer();
// On prépare la led de localisation
initLocateLed();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
bool readCmd() {
if (udp.parsePacket() > 0) {
uint8_t len = udp.available();
char c = udp.read();
if (len == 1) {
if (c == CMD_RESET) {
player.softReset();
sendPacket(CMD_RESET);
return true;
} else if (c == CMD_VOLUME) {
sendPacket(volume_level);
return true;
} else if (c == CMD_LOCATE) {
if (!isLocate) {
locate(true);
sendPacket(CMD_LOCATE);
return true;
}
}
} else if (len == 2) {
char value = udp.read();
if (c == CMD_VOLUME) {
if (value == '+' && volume_level != 100) {
setVolume(volume_level + 1);
} else if (value == '-' && volume_level != 0) {
setVolume(volume_level - 1);
} else {
sendNack();
return false;
}
return true;
}
} else {
if (c == CMD_VOLUME) {
char value[4] = "0";
udp.read(value, 3);
uint8_t vol = atoi(value);
if (vol >= 0 && vol <= 100) {
setVolume(vol);
return true;
}
}
}
sendNack();
return false;
}
// Check if locate needs to be done
locate(false);
}
void locate(bool blink) {
if (blink) {
// Initialisation des variables
digitalWrite(ledPin, LOW);
isLocate = true;
repetition = 0;
timer = millis();
} else if (isLocate) {
// Calcule du temps
uint32_t elapsed = millis() - timer;
if (elapsed > BLINK_FREQ) {
repetition++;
if (repetition == BLINK_REP) {
// On a atteint le nombre de clignotements
isLocate = false;
digitalWrite(ledPin, HIGH);
} else {
// On fait clignoter la led
digitalWrite(ledPin, !digitalRead(ledPin));
timer = millis();
}
}
}
}

void setVolume(uint8_t vol) {
volume_level = vol;
Serial.printf("Setting volume to %d\n", volume_level);
player.setVolume(volume_level);
sendPacket(volume_level);
}

void sendNack() {
sendPacket(RESPONSE_NOK);
}

void sendPacket(const char content) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(const char content[]) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(int content) {
char value[4];
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(itoa(content, value, 10));
udp.endPacket();
}

void initCmdServer() {
// Démarrage du serveur TCP
udp.begin(CMD_PORT);
Serial.printf("Ecoute UDP sur le port %d\n", CMD_PORT);
}

void initLocateLed() {
pinMode(ledPin, OUTPUT);
digitalWrite(ledPin, HIGH);
}
</source>
L'ESP est maintenant capable de :
* monter / baisser le volume ;
* de faire un reset du lecteur MP3 (en cas de problème)
* de faire clignoter sa led pour être localisé facilement.

= Enceinte armbian =
Même objectif mais cette fois-ci avec Rygel, un lecteur DLNA.
==Installation ==
Le système:
<pre>
# apt-get update
</pre>
Le lecteur rygel:
<pre>
# apt-get -y install rygel-playbin
</pre>
Les différents plugins. Tout d'abord, récupérer les plugins en fonctions de la distribution:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | awk -F ' - ' '{print $1}')
</pre>
Ensuite on procéde à l'installation:
<pre>
# apt-get install ${plugins}
</pre>

== Création du fichier de service ==
Il suffit de créer le fichier ''/etc/systemd/system/rygel.service'':
<pre>
[Unit]
Description=Rygel service
After=network-online.target

[Service]
Type=simple
UMask=007
ExecStart=/usr/bin/rygel -g 5
Restart=on-failure

# Configures the time to wait before service is stopped forcefully.
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
On peut lancer le service et l'activer au démarrage
<pre>
# systemctl start rygel
# systemctl enable rygel
</pre>
== Désactivation des logs ==
Comme l'enceinte n'est pas à proprement parler un serveur exécutant un service critique, on peut désactiver le système de logging pour économiser la durée de vie de la carte SD:
<pre>
# systemctl stop rsyslog
# systemctl disable rsyslog
</pre>
== Ajustement du volume ==
Il faut maintenant mettre le volume au maximum coté Pi avec le mixer ALSA [https://fr.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture wikipedia] :
<pre>
# alsamixer
</pre>
[[Fichier:alsamixer armbian.png|centré]]
== Changement de la carte son par défaut ==
Une fois la carte son USB installée, il suffit d'utiliser la commande suivante pour voir son identifiant:
<pre>
# aplay -l
**** List of PLAYBACK Hardware Devices ****
card 0: sun4icodec [sun4i-codec], device 0: CDC PCM Codec-0 []
Subdevices: 1/1
Subdevice #0: subdevice #0
card 1: Device [USB Audio Device], device 0: USB Audio [USB Audio]
Subdevices: 0/1
Subdevice #0: subdevice #0
</pre>
La carte son avec l'ID ''0'' est celle intégrée au PI, celle avec l'ID ''1'' est la carte USB.
Pour dire à ALSA que c'est la carte avec l'ID ''1'' que l'on veut par défaut, il suffit de créer le fichier ''/etc/asound.conf'' avec les lignes suivantes:
<pre>
defaults.pcm.card 1
defaults.ctl.card 1
</pre>
La configuration est appliquée après un redémarrage !

== WiringPI==
===Installation===
Pour le Banana Pi M1:
<pre>
# cd /opt
# git clone https://github.com/LeMaker/WiringLMK.git
# cd WiringLMK
# chmod +x ./build
# ./build
</pre>
Pour le Raspberry Pi 2:
<pre>
# apt install -y wiringpi
</pre>

=== Utilisation===
Pour la lecture des états
<pre>
# gpio readall
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| | | 3.3v | | | 1 || 2 | | | 5v | | |
| 2 | 8 | SDA.1 | ALT5 | 0 | 3 || 4 | | | 5V | | |
| 3 | 9 | SCL.1 | ALT5 | 0 | 5 || 6 | | | 0v | | |
| 4 | 7 | GPIO. 7 | IN | 0 | 7 || 8 | 1 | ALT2 | TxD | 15 | 14 |
| | | 0v | | | 9 || 10 | 0 | IN | RxD | 16 | 15 |
| 17 | 0 | GPIO. 0 | IN | 0 | 11 || 12 | 0 | IN | GPIO. 1 | 1 | 18 |
| 27 | 2 | GPIO. 2 | IN | 0 | 13 || 14 | | | 0v | | |
| 22 | 3 | GPIO. 3 | IN | 0 | 15 || 16 | 0 | IN | GPIO. 4 | 4 | 23 |
| | | 3.3v | | | 17 || 18 | 0 | IN | GPIO. 5 | 5 | 24 |
| 10 | 12 | MOSI | ALT5 | 0 | 19 || 20 | | | 0v | | |
| 9 | 13 | MISO | ALT5 | 0 | 21 || 22 | 0 | IN | GPIO. 6 | 6 | 25 |
| 11 | 14 | SCLK | ALT5 | 0 | 23 || 24 | 0 | ALT5 | CE0 | 10 | 8 |
| | | 0v | | | 25 || 26 | 0 | ALT5 | CE1 | 11 | 7 |
| 0 | 30 | SDA.0 | IN | 1 | 27 || 28 | 1 | IN | SCL.0 | 31 | 1 |
| 5 | 21 | GPIO.21 | IN | 0 | 29 || 30 | | | 0v | | |
| 6 | 22 | GPIO.22 | ALT4 | 0 | 31 || 32 | 0 | ALT4 | GPIO.26 | 26 | 12 |
| 13 | 23 | GPIO.23 | IN | 0 | 33 || 34 | | | 0v | | |
| 19 | 24 | GPIO.24 | IN | 0 | 35 || 36 | 0 | IN | GPIO.27 | 27 | 16 |
| 26 | 25 | GPIO.25 | IN | 0 | 37 || 38 | 0 | IN | GPIO.28 | 28 | 20 |
| | | 0v | | | 39 || 40 | 0 | IN | GPIO.29 | 29 | 21 |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
</pre>
Ou d'un état:
<pre>
# gpio read 1
0
</pre>
Changement d'état:
<pre>
# gpio -1 write 8 0
</pre>

== Détection de musique ==
Il est possible de détecter si de la musique est en train d'être jouée sur le PI grâce à la commande suivante:
<pre>
# cat /proc/asound/card*/pcm*/sub*/status | grep RUNNING | wc -l
</pre>
Si cette commande renvoie ''1'' cela veut dire que ''state: RUNNING'' est présent dans un des fichiers d'une des cartes son.

Cette commande peu permettre de piloter un amplificateur au travers d'un relais piloté par une GPIO...

== Ajout du bluetooth ==
Il faut d'abord installer blueZ:
<pre>
# apt-get install -y bluez bluez-tools
</pre>

Iot speaker

2019-07-19T15:13:43Z

Tala : /* Installation */

=Projet=
{|class="wikitable" width="100%"
|-valign=top
! Objectif !! Les acteurs !! Compétences !! Matériel
|-valign=top
||
Construire des enceintes sans-fils (sauf le courant) actives connectées capables de travailler en "groupe"
||
*[[User:Tala | Tala]]
*[[User:Nigdor |Nigdor]]
*[[User:Prandar |Prandar]]
||
*électronique
*C++ (microcontrôleur)
||
* microcontrôleur (esp8266)
* amplificateur audio (XPT8871, PAM8403, ...)
* décodeur MP3 (VS1053B)
* potentiomètre digital (X9C103S)
|}

= Choix de l'amplificateur =
A faire:
*Expliquer la différence entre classe AB et D (qualité sonore vs. éco énergie)
*Faire un tableau récapitulatif des caractéristiques des amplis:
** mono / stéréo / les deux
** tension de fonctionnement / consommation (5v, 12v, 24v, etc...)
** puissance (5w, 20w, 30w, etc...)
** impédance de sortie (2 x 4Ω, 1 x 8Ω, etc...)
** réponse fréquentielle ;
** résistance aux courts-circuits ;
** bruit pop (quand pas de musique);
** besoin d'un dissipateur ou non (effet joule à prévoir...)
** lien vers la documentation si besoin d'info(eg. pour le [https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932])
** le plus important : le ressenti !
==Classe AB==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
TDA7297
|align=center|
[[Fichier:TDA7297.png|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 15W
|align=center|
2A (peak)
|align=center|
6 - 18 V
|align=center|
OUI
|align=center|
Avec µControlleur<br>(p. 3/4)
|align=center|
Obligatoire
|align=center|
[http://www.st.com/content/ccc/resource/technical/document/datasheet/a3/eb/9b/59/dd/26/4a/27/CD00001048.pdf/files/CD00001048.pdf/jcr:content/translations/en.CD00001048.pdf TDA7297]
|align=left|
Super amplification sans distorsion !
<br>
Forte dissipation thermique à pleine puissance :
* 33W d'après la doc;
* vraiment très (trop) fort !
|}
</div>

==Classe D==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
XH-M531 (YDA138)
|align=center|
[[Fichier:XH-M531.jpg|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 10 W<br>
2 x 20 W
|align=center|
8 Ω<br>
4 Ω
|align=center|
12 - 15V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.ksp-electronics.com/product_files/8eeedc66ea8fbcdf2e74294037c2f389 YDA138]
|align=center|
|-valign="top"
|align=center|
PAM8403
|align=center|
[[Fichier:PAM8403.jpg|centré|100px]]
|align=center|
Stéréo
|align=center|
3W(*2 ?)
|align=center|
4 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
Reduit mais présent
|align=center|
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8403.pdf PAM8403]
|align=center|
|-valign="top"
|align=center|
PAM8610
|align=center|
[[Fichier:PAM8610.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 10 W
|align=center|
8 Ω
|align=center|
7 - 15 V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8610.pdf PAM8610]
|align=center|
|-valign="top"
|align=center|
XPT8871
|align=center|
[[Fichier:XPT8871.jpg|centré|120px]]
|align=center|
Mono
|align=center|
3.5w
<br>
5w
|align=center|
3 Ω
<br>
2 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[[Media:XPT8871.pdf|XPT8871]]
|align=left|
*Bien pour la voix, pas top pour la musique
|-valign="top"
|align=center|
TDA8932
|align=center|
[[Fichier:TDA8932.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2*15W
|align=center|
4 Ω
|align=center|
Entre 10 V et 36 V (Rechercher quel est le plus optimal)
|align=center|
OUI
|align=center|
NON
|align=center|

|align=center|
[https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932]
|align=center|
|-valign="top"
|align=center|
TPA3110
|align=center|
[[Fichier:TPA3110.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
15W/ch
|align=center|
8 Ω
|align=center|
16 V
|align=center|
OUI
|align=center|
NON
|align=center|
OUI
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3110d2.pdf TPA3110]
|align=left|
*Amplification moyenne
*Basses creuses
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3116
|align=center|
[[Fichier:TPA3116.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 50W<br>
2 x 15W
|align=center|
4 Ω<br>
8 Ω
|align=center|
21 V<br>
15 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI<br>
NON
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3116d2.pdf TPA3116]
|align=left|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3118
|align=center|
[[Fichier:TPA3118.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 30W
|align=center|
8 Ω
|align=center|
12 - 24 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI
|align=left|
[http://www.ti.com/lit/ds/symlink/tpa3118d2.pdf TPA3118]
|align=center|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|}
</div>

= Potentiomètre digital =
A faire

= Décodeur MP3 =
==Présentation==
Le décodeur MP3 choisi est le VS1053

[[Fichier:vs1053_board.jpg|centré|200px]]

Ce décodeur offre une interface SPI et permet de lire ainsi que d'enregistrer des fichiers aux formats :
* lecture :
**MP3 ;
**Ogg Vorbis (libre de droit) ;
**PCM;
**WAV;
* enregistrement :
**Ogg Vorbis(libre de droit) ;

==Documentation technique==
Voici la [[:Media:vs1053_doc.pdf|documentation du VS1053]], pour ceux qui voudraient écrire une librairie C++ !

== Schéma ==
Les tests ont été réalisés avec un WemOS D1 mini (ESP8266) :
<div align="center">
{|class="wikitable" width="85%"
! ESP8266 !! VS1053 !! Connections
|-valign=top
||
[[Fichier:wemos_D1_R2_mini_diagram.png|centré|470px]]
||
[[Fichier:vs1053_board_diagram.png|centré|300px]]
|align="center"|
{|class="wikitable"
! ESP8266 !! VS1053
|-
|align="center"| D0
|align="center"| XDCS
|-
|align="center"| D1
|align="center"| XoS (Cable Select)
|-
|align="center"| D3
|align="center"| DREQ
|-
|align="center"| D5
|align="center"| SCK (Serial ClocK)
|-
|align="center"| D6
|align="center"| MISO (Master In Slave Out)
|-
|align="center"| D7
|align="center"| MOSI (Master Out Slave In)
|-
|align="center"| RST
|align="center"| XRST
|-
|align="center"| 5V
|align="center"| 5V
|-
|align="center"| G
|align="center"| DGND
|}
|}
</div>
Vous devriez avoir quelque chose comme ça :

[[Fichier:wemos_D1_vs1053_diagram.jpg|centré|400px]]

== Programmation ==
Tout d'abord un grand merci à [https://github.com/baldram/ESP_VS1053_Library ''baldram''] pour sa [[Media:ESP_VS1053_Library.zip|librairie]] que nous allons utiliser !

Le plus simple est de regarder l'exemple ''SimpleMP3Player'' fourni avec la librairie :
<source lang="c">
// La fameuse librairie de baldram
#include <VS1053.h>
// Un MP3 au format binaire dans un tableau (le fichier est livré avec la librairie)
#include <helloMp3.h>
// Définition des port SPI utilisé (ici pour l'ESP8266)
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
// Définition du volume
#define VOLUME 80 // volume level 0-100
// Création de l'objet VS1053
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);

void setup () {
// Démarrage du SPI
SPI.begin();
// démarrage du VS1053
player.begin();
// Ligne nécessaire pour certain lecteur
player.switchToMp3Mode();
player.setVolume(VOLUME);
}

void loop() {
// On joue le MP3 dans le tableau
player.playChunk(helloMp3, sizeof(helloMp3));
// On attend 3 secondes
delay(3000);
}
</source>
Pour que cet exemple fonctionne, il faut soit copier le contenu de ''HelloMp3.h'' dans le fichier exemple, soit copier le fichier dans le répertoire de la librairie dans votre dossier ''Arduino''.

Une fois la compilation terminée, vous devriez entendre ''du bruit'' sortir du VS1053 !

= Flux musical =
La communication se fera en générant un flux entre le programme (PC) et l'enceinte (ESP8266). Ce flux, pour des raisons de simplicité, se fera en TCP car ce protocole gère les retransmissions, les tampons d'entrée / sortie, etc...

A terme, une application temps réel comme la musique mériterait de passer sur de l'UDP. Surtout que, si l'on souhaite utiliser du [https://www.tala-informatique.fr/wiki/index.php/Esp8266_udp_server multicast], pour parler à un groupe d'enceintes, on ne peut le faire qu'en UDP !
== Envoi : serveur en PHP ==
La partie serveur prend un fichier, ici un MP3, lit un morceau du fichier et l'envoi à l'enceinte à travers une socket TCP. Deux paramètres sont à prendre en compte :
*le temps d'attente entre chaque envoi;
*la taille d'un morceau;
Ces paramètres nécessiteront certainement un temps d'ajustement qui sera en fonction de la latence, la congestion du réseau, les capacités des puces impliquées (ici l'ESP8266), etc...
{|style="width:650px" align="center"
|
[[Fichier:warning-icon.png|centré|60px]]
|valign="top" align="justify"|
Les extraits de code qui vont suivre respectent vaguement les préceptes, au combien importants, de la programmation orientée objet et sont fournis à titre indicatif dans l'unique but de démontrer la faisabilité d'un tel projet ! Voici [[:Media:Iot_Speaker.zip | l'archive]] qui contient le code exposé ci-dessous.
|}
=== MusicSender ===
Voici le contenu du fichier ''MusicSender.class.php'' :
<source lang="php">
<?php

class MusicSender
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5045;

// Le temps d'attente en microsecondes entre chaque paquets
private static $SLEEP_INTERVAL = 2500;

// La taille de chacun des paquets
private static $CHUNK_BUFFER = 32768;

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Envoie le MP3 à l'enceinte
*
* @param string $mp3File
* @return boolean
*/
public function play($mp3File)
{
if (is_file($mp3File)) {
// Ouverture du fichier en lecture binaire
$file = fopen($mp3File, 'rb');
if ($file === FALSE) {
echo "Fail reading file " . $file . "\n";
return FALSE;
}
// Ouverture de la socket
$socket = $this->openSocket();
// Tant qu'on est pas à la fin du fichier
while (! feof($file)) {
// Envoie d'un "morceau" de taille CHUNK_BUFFER à l'enceinte
if (@socket_write($this->socket, fread($file, self::$CHUNK_BUFFER), self::$CHUNK_BUFFER) === FALSE) {
// Problème de socket (fermeture, déconnexion, etc...)
return FALSE;
}
usleep(self::$SLEEP_INTERVAL);
}
// Fermeture de la socket
$this->closeSocket();
// Fermeture du fichier
fclose($file);
return TRUE;
}
echo $file." does not exists !\n";
return FALSE;
}

/**
* Lit tous les mp3 présents dans le dossier
*
* @param string $dir
*/
public function readFolder($dir)
{
if (is_dir($dir)) {
// On récupére les fichiers sans les 2 premiers '.' et '..'
$files = array_slice(scandir($dir), 2);
foreach ($files as $file) {
// On créé le chemin absolu
$mp3File = $dir . DIRECTORY_SEPARATOR . $file;
// On test l'extension
if (pathinfo($file)["extension"] == "mp3") {
$this->play($mp3File);
}
}
return true;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) == FALSE) {
echo "socket_create_listen() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
if (socket_connect($this->socket, $this->ip, self::$PORT) == FALSE) {
echo "socket_bind() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
=== Launch.php ===
On créé un fichier ''Launch.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicSender.class.php';

$esp_ip = "192.168.1.200";

$dir = "!!chemin_vers_des_fichiers_mp3!!";

$sender = new MusicSender($esp_ip);

$sender->readFolder($dir);
</source>

== Réception : ESP8266 ==
{|style="width:650px" align="center"
|
[[Fichier:Warning manual.jpg|centré|300px]]
|valign="top" align="justify"|
Soyez sûr de comprendre la section sur [https://www.tala-informatique.fr/wiki/index.php/Arduino_sketch_writing| comment écrire un sketch] avant de poursuivre. Le code ci-dessous fait référence à des parties bien spécifiques, détaillées et expliquées dans la section suscitée.
|}
=== Partie WiFi ===
La première étape consiste à raccorder notre ''ESP'' au réseau WiFi !
<source lang="c">
#include <ESP8266WiFi.h>
#include <WiFiClient.h>

// WiFi Parameters //
const char ssid[] = "cfcasa";
const char password[] = "***********";
IPAddress ip(192, 168, 1, 200);
IPAddress gw(192, 168, 1, 254);
IPAddress mask(255, 255, 252, 0);

void setup() {
// on démarre le port série
Serial.begin(115200);
// On attend "un peu" que le buffer soit prêt
delay(10);
// On démarre le WiFi
initWiFi();
}

void loop() {
}

void initWiFi() {
// On efface la configuration précédente
WiFi.disconnect(true);
Serial.printf("\nConnexion a %s", ssid);
// Initialisation de la connection
WiFi.config(ip, gw, mask, gw);
WiFi.begin(ssid, password);
// Test pour déterminer quand la connection est prete
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(".");
}
// Affichage des informations
Serial.printf(" connecté\nAdresse IP: %s\n", WiFi.localIP().toString().c_str());
}
</source>
=== Lecteur MP3 ===
Vient ensuite la partie du lecteur MP3. Dans la partie des imports, ajoutez la ligne suivante :
<source lang="c">
#include <VS1053.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Parameters //
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
#define VOLUME 70 // volume level 0-100
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);
uint8_t volume_level = VOLUME;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le shield MP3
initMP3();
</source>
A la suite, on insère la fonction suivante :
<source lang="c">
void initMP3() {
SPI.begin();
// Démarrage du lecteur MP3
player.begin();
player.switchToMp3Mode();
player.setVolume(volume_level);
}
</source>
=== Récupération du stream MP3 ===
On va maintenant récupérer le flux envoyé depuis le serveur. Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Server parameters //
const uint16_t MP3_PORT = 5045;
WiFiServer server(MP3_PORT);
const uint16_t BUFFER_SIZE = 16384;
//const uint16_t BUFFER_SIZE = 32768;
byte buffer[BUFFER_SIZE + 1];
uint16_t byteRead = 0;
bool isBufferReady = false;
WiFiClient client;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur TCP
initMp3Server();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
void initMp3Server() {
// Démarrage du serveur TCP
server.begin();
Serial.printf("Ecoute TCP sur le port %d\n", MP3_PORT);
}

void readMp3() {
// Un client est connecté
if (client) {
// Si le client est toujours connecté...
if (client.connected()) {
// Tant que l'on reçoit de la musique
while (client.available() > 0) {
// On rempli le buffer avec le contenu du paquet TCP
buffer[byteRead++] = client.read();
// Si le buffer est plein
if (byteRead == BUFFER_SIZE) {
// On previent que le buffer est plein
isBufferReady = true;
// On sort de la boucle
break;
}
}
// Si le buffer est plein
if (isBufferReady) {
// On envoi tout au lecteur MP3
player.playChunk(buffer, byteRead);
// On RAZ le compteur de bytes
byteRead = 0;
}
} else {
// Si le client est déconneté
client = server.available();
// On prévient que le buffer est vide
isBufferReady = false;
// On RAZ le compteur de bytes
byteRead = 0;
Serial.println(F("Client disconnected"));
}
} else {
// On test la présence d'un client
client = server.available();
if (client) {
// Un client est connecté !
Serial.println(F("New client !"));
}
}
}
</source>
Enfin, on ajoute le ligne suivante dans la fonction ''loop()'' :
<source lang="c">
readMp3();
</source>
A ce stade, l'ESP devrait être capable de récupérer le flux et de le jouer !

= Envoi de commandes =
Envoyer de la musique c'est bien, pouvoir régler le volume c'est encore mieux !

La façon la plus simple d'adresser le problème c'est d'utiliser un autre port et, comme les messages sont petits, d'utiliser UDP.
== Partie Serveur ==
Dans la même veine, voici la classe qui permet d'envoyer les commandes :
<source lang="php">
<?php

class MusicHandler
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5046;

// Le port de l'enceinte connectée
private static $RETRIES = 3;

// Liste de commandes
private static $CMD_VOLUME = 'V';

private static $CMD_LOCATE = 'L';

private static $CMD_RESET = 'R';

private static $RESPONSE_NOK = 'N';

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Augmente le volume d'un incrément
*
* @return boolean
*/
public function volumeUp()
{
return $this->sendCommand(self::$CMD_VOLUME . "+");
}

/**
* Baisse le volume d'un incrément
*
* @return boolean
*/
public function volumeDown()
{
return $this->sendCommand(self::$CMD_VOLUME . "-");
}

/**
*
* @return boolean
*/
public function setVolume($volume)
{
if ($volume < 0 || $volume > 100) {
return false;
}
return $this->sendCommand(self::$CMD_VOLUME . $volume);
}

public function getVolume(){
return $this->sendCommand(self::$CMD_VOLUME);
}

/**
*
* @return boolean
*/
public function doReset()
{
return $this->sendCommand(self::$CMD_RESET);
}

public function doLocate(){
return $this->sendCommand(self::$CMD_LOCATE);
}

/**
* Envoie une commande au module
*
* @param string $message
*/
private function sendCommand($message)
{
$result = false;
if ($this->openSocket() !== FALSE) {
if (socket_sendto($this->socket, $message, strlen($message), 0, $this->ip, self::$PORT) !== FALSE) {
$result = $this->readAcknoledge();
}
}
$this->closeSocket();
return $result;
}

/**
* Attend la confirmation de la commande
*
* @return boolean
*/
private function readAcknoledge()
{
$buf = "";
$retries = 0;
while ($retries < self::$RETRIES) {
$byteReceived = socket_recvfrom($this->socket, $buf, 2048, 0, $this->ip, self::$PORT);
if ($byteReceived > 0) {
return $buf != self::$RESPONSE_NOK ? $buf : FALSE;
}
usleep(500000);
$retries ++;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) === FALSE) {
$errorcode = socket_last_error();
$errormsg = socket_strerror($errorcode);
echo ("Couldn't create socket: [$errorcode] $errormsg \n");
return false;
}
return true;
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
On créé un fichier ''Command.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicHandler.class.php';

$esp_ip = "192.168.1.200";

$handler = new MusicHandler($esp_ip);

// Exemple de commandes //
//$result = $handler->volumeUp();
//$result = $handler->getVolume();
//$result = $handler->doReset();
//$result = $handler->setVolume(70);

$result = $handler->doLocate();

echo $result !== FALSE ? "ok : $result\n" : "nok\n";
</source>
== Partie Cliente ==
Dans la partie des imports ajoutez la ligne suivante :
<source lang="c">
#include <WiFiUDP.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// Command Server parameters //
const uint16_t CMD_PORT = 5046;
// L'instance du serveur UDP
WiFiUDP udp;
// Liste de commandes
const char CMD_VOLUME = 'V';
const char CMD_LOCATE = 'L';
const char CMD_RESET = 'R';
const char RESPONSE_NOK[] = "N";

// Localisation parameters
uint8_t ledPin = LED_BUILTIN;
const uint16_t BLINK_FREQ = 500;
const uint8_t BLINK_REP = 60;
uint8_t repetition = 0;
uint32_t timer;
bool isLocate = false;
</source>
A la fin de la fonction setup() nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur UDP
initCmdServer();
// On prépare la led de localisation
initLocateLed();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
bool readCmd() {
if (udp.parsePacket() > 0) {
uint8_t len = udp.available();
char c = udp.read();
if (len == 1) {
if (c == CMD_RESET) {
player.softReset();
sendPacket(CMD_RESET);
return true;
} else if (c == CMD_VOLUME) {
sendPacket(volume_level);
return true;
} else if (c == CMD_LOCATE) {
if (!isLocate) {
locate(true);
sendPacket(CMD_LOCATE);
return true;
}
}
} else if (len == 2) {
char value = udp.read();
if (c == CMD_VOLUME) {
if (value == '+' && volume_level != 100) {
setVolume(volume_level + 1);
} else if (value == '-' && volume_level != 0) {
setVolume(volume_level - 1);
} else {
sendNack();
return false;
}
return true;
}
} else {
if (c == CMD_VOLUME) {
char value[4] = "0";
udp.read(value, 3);
uint8_t vol = atoi(value);
if (vol >= 0 && vol <= 100) {
setVolume(vol);
return true;
}
}
}
sendNack();
return false;
}
// Check if locate needs to be done
locate(false);
}
void locate(bool blink) {
if (blink) {
// Initialisation des variables
digitalWrite(ledPin, LOW);
isLocate = true;
repetition = 0;
timer = millis();
} else if (isLocate) {
// Calcule du temps
uint32_t elapsed = millis() - timer;
if (elapsed > BLINK_FREQ) {
repetition++;
if (repetition == BLINK_REP) {
// On a atteint le nombre de clignotements
isLocate = false;
digitalWrite(ledPin, HIGH);
} else {
// On fait clignoter la led
digitalWrite(ledPin, !digitalRead(ledPin));
timer = millis();
}
}
}
}

void setVolume(uint8_t vol) {
volume_level = vol;
Serial.printf("Setting volume to %d\n", volume_level);
player.setVolume(volume_level);
sendPacket(volume_level);
}

void sendNack() {
sendPacket(RESPONSE_NOK);
}

void sendPacket(const char content) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(const char content[]) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(int content) {
char value[4];
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(itoa(content, value, 10));
udp.endPacket();
}

void initCmdServer() {
// Démarrage du serveur TCP
udp.begin(CMD_PORT);
Serial.printf("Ecoute UDP sur le port %d\n", CMD_PORT);
}

void initLocateLed() {
pinMode(ledPin, OUTPUT);
digitalWrite(ledPin, HIGH);
}
</source>
L'ESP est maintenant capable de :
* monter / baisser le volume ;
* de faire un reset du lecteur MP3 (en cas de problème)
* de faire clignoter sa led pour être localisé facilement.

= Enceinte armbian =
Même objectif mais cette fois-ci avec Rygel, un lecteur DLNA.
==Installation ==
Le système:
<pre>
# apt-get update
</pre>
Le lecteur rygel:
<pre>
# apt-get -y install rygel-playbin
</pre>
Les différents plugins. Tout d'abord, récupérer les plugins en fonctions de la distribution:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | awk -F ' - ' '{print $1}')
</pre>
Ensuite on procéde à l'installation:
<pre>
# apt-get install ${plugins}
</pre>

== Création du fichier de service ==
Il suffit de créer le fichier ''/etc/systemd/system/rygel.service'':
<pre>
[Unit]
Description=Rygel service
After=network-online.target

[Service]
Type=simple
UMask=007
ExecStart=/usr/bin/rygel -g 5
Restart=on-failure

# Configures the time to wait before service is stopped forcefully.
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
On peut lancer le service et l'activer au démarrage
<pre>
# systemctl start rygel
# systemctl enable rygel
</pre>
== Désactivation des logs ==
Comme l'enceinte n'est pas à proprement parler un serveur exécutant un service critique, on peut désactiver le système de logging pour économiser la durée de vie de la carte SD:
<pre>
# systemctl stop rsyslog
# systemctl disable rsyslog
</pre>
== Ajustement du volume ==
Il faut maintenant mettre le volume au maximum coté Pi avec le mixer ALSA [https://fr.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture wikipedia] :
<pre>
# alsamixer
</pre>
[[Fichier:alsamixer armbian.png|centré]]
== Changement de la carte son par défaut ==
Une fois la carte son USB installée, il suffit d'utiliser la commande suivante pour voir son identifiant:
<pre>
# aplay -l
**** List of PLAYBACK Hardware Devices ****
card 0: sun4icodec [sun4i-codec], device 0: CDC PCM Codec-0 []
Subdevices: 1/1
Subdevice #0: subdevice #0
card 1: Device [USB Audio Device], device 0: USB Audio [USB Audio]
Subdevices: 0/1
Subdevice #0: subdevice #0
</pre>
La carte son avec l'ID ''0'' est celle intégrée au PI, celle avec l'ID ''1'' est la carte USB.
Pour dire à ALSA que c'est la carte avec l'ID ''1'' que l'on veut par défaut, il suffit de créer le fichier ''/etc/asound.conf'' avec les lignes suivantes:
<pre>
defaults.pcm.card 1
defaults.ctl.card 1
</pre>
La configuration est appliquée après un redémarrage !

== WiringPI==
===Installation===
<pre>
# cd /opt
# git clone https://github.com/LeMaker/WiringLMK.git
# cd WiringLMK
# chmod +x ./build
# ./build
</pre>

=== Utilisation===
Pour la lecture des états
<pre>
# gpio readall
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| | | 3.3v | | | 1 || 2 | | | 5v | | |
| 2 | 8 | SDA.1 | ALT5 | 0 | 3 || 4 | | | 5V | | |
| 3 | 9 | SCL.1 | ALT5 | 0 | 5 || 6 | | | 0v | | |
| 4 | 7 | GPIO. 7 | IN | 0 | 7 || 8 | 1 | ALT2 | TxD | 15 | 14 |
| | | 0v | | | 9 || 10 | 0 | IN | RxD | 16 | 15 |
| 17 | 0 | GPIO. 0 | IN | 0 | 11 || 12 | 0 | IN | GPIO. 1 | 1 | 18 |
| 27 | 2 | GPIO. 2 | IN | 0 | 13 || 14 | | | 0v | | |
| 22 | 3 | GPIO. 3 | IN | 0 | 15 || 16 | 0 | IN | GPIO. 4 | 4 | 23 |
| | | 3.3v | | | 17 || 18 | 0 | IN | GPIO. 5 | 5 | 24 |
| 10 | 12 | MOSI | ALT5 | 0 | 19 || 20 | | | 0v | | |
| 9 | 13 | MISO | ALT5 | 0 | 21 || 22 | 0 | IN | GPIO. 6 | 6 | 25 |
| 11 | 14 | SCLK | ALT5 | 0 | 23 || 24 | 0 | ALT5 | CE0 | 10 | 8 |
| | | 0v | | | 25 || 26 | 0 | ALT5 | CE1 | 11 | 7 |
| 0 | 30 | SDA.0 | IN | 1 | 27 || 28 | 1 | IN | SCL.0 | 31 | 1 |
| 5 | 21 | GPIO.21 | IN | 0 | 29 || 30 | | | 0v | | |
| 6 | 22 | GPIO.22 | ALT4 | 0 | 31 || 32 | 0 | ALT4 | GPIO.26 | 26 | 12 |
| 13 | 23 | GPIO.23 | IN | 0 | 33 || 34 | | | 0v | | |
| 19 | 24 | GPIO.24 | IN | 0 | 35 || 36 | 0 | IN | GPIO.27 | 27 | 16 |
| 26 | 25 | GPIO.25 | IN | 0 | 37 || 38 | 0 | IN | GPIO.28 | 28 | 20 |
| | | 0v | | | 39 || 40 | 0 | IN | GPIO.29 | 29 | 21 |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
</pre>
Ou d'un état:
<pre>
# gpio read 1
0
</pre>
Changement d'état:
<pre>
# gpio -1 write 8 0
</pre>

== Détection de musique ==
Il est possible de détecter si de la musique est en train d'être jouée sur le PI grâce à la commande suivante:
<pre>
# cat /proc/asound/card*/pcm*/sub*/status | grep RUNNING | wc -l
</pre>
Si cette commande renvoie ''1'' cela veut dire que ''state: RUNNING'' est présent dans un des fichiers d'une des cartes son.

Cette commande peu permettre de piloter un amplificateur au travers d'un relais piloté par une GPIO...

== Ajout du bluetooth ==
Il faut d'abord installer blueZ:
<pre>
# apt-get install -y bluez bluez-tools
</pre>

Iot speaker

2019-07-17T04:17:20Z

Tala : /* Détection de musique */

=Projet=
{|class="wikitable" width="100%"
|-valign=top
! Objectif !! Les acteurs !! Compétences !! Matériel
|-valign=top
||
Construire des enceintes sans-fils (sauf le courant) actives connectées capables de travailler en "groupe"
||
*[[User:Tala | Tala]]
*[[User:Nigdor |Nigdor]]
*[[User:Prandar |Prandar]]
||
*électronique
*C++ (microcontrôleur)
||
* microcontrôleur (esp8266)
* amplificateur audio (XPT8871, PAM8403, ...)
* décodeur MP3 (VS1053B)
* potentiomètre digital (X9C103S)
|}

= Choix de l'amplificateur =
A faire:
*Expliquer la différence entre classe AB et D (qualité sonore vs. éco énergie)
*Faire un tableau récapitulatif des caractéristiques des amplis:
** mono / stéréo / les deux
** tension de fonctionnement / consommation (5v, 12v, 24v, etc...)
** puissance (5w, 20w, 30w, etc...)
** impédance de sortie (2 x 4Ω, 1 x 8Ω, etc...)
** réponse fréquentielle ;
** résistance aux courts-circuits ;
** bruit pop (quand pas de musique);
** besoin d'un dissipateur ou non (effet joule à prévoir...)
** lien vers la documentation si besoin d'info(eg. pour le [https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932])
** le plus important : le ressenti !
==Classe AB==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
TDA7297
|align=center|
[[Fichier:TDA7297.png|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 15W
|align=center|
2A (peak)
|align=center|
6 - 18 V
|align=center|
OUI
|align=center|
Avec µControlleur<br>(p. 3/4)
|align=center|
Obligatoire
|align=center|
[http://www.st.com/content/ccc/resource/technical/document/datasheet/a3/eb/9b/59/dd/26/4a/27/CD00001048.pdf/files/CD00001048.pdf/jcr:content/translations/en.CD00001048.pdf TDA7297]
|align=left|
Super amplification sans distorsion !
<br>
Forte dissipation thermique à pleine puissance :
* 33W d'après la doc;
* vraiment très (trop) fort !
|}
</div>

==Classe D==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
XH-M531 (YDA138)
|align=center|
[[Fichier:XH-M531.jpg|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 10 W<br>
2 x 20 W
|align=center|
8 Ω<br>
4 Ω
|align=center|
12 - 15V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.ksp-electronics.com/product_files/8eeedc66ea8fbcdf2e74294037c2f389 YDA138]
|align=center|
|-valign="top"
|align=center|
PAM8403
|align=center|
[[Fichier:PAM8403.jpg|centré|100px]]
|align=center|
Stéréo
|align=center|
3W(*2 ?)
|align=center|
4 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
Reduit mais présent
|align=center|
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8403.pdf PAM8403]
|align=center|
|-valign="top"
|align=center|
PAM8610
|align=center|
[[Fichier:PAM8610.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 10 W
|align=center|
8 Ω
|align=center|
7 - 15 V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8610.pdf PAM8610]
|align=center|
|-valign="top"
|align=center|
XPT8871
|align=center|
[[Fichier:XPT8871.jpg|centré|120px]]
|align=center|
Mono
|align=center|
3.5w
<br>
5w
|align=center|
3 Ω
<br>
2 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[[Media:XPT8871.pdf|XPT8871]]
|align=left|
*Bien pour la voix, pas top pour la musique
|-valign="top"
|align=center|
TDA8932
|align=center|
[[Fichier:TDA8932.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2*15W
|align=center|
4 Ω
|align=center|
Entre 10 V et 36 V (Rechercher quel est le plus optimal)
|align=center|
OUI
|align=center|
NON
|align=center|

|align=center|
[https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932]
|align=center|
|-valign="top"
|align=center|
TPA3110
|align=center|
[[Fichier:TPA3110.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
15W/ch
|align=center|
8 Ω
|align=center|
16 V
|align=center|
OUI
|align=center|
NON
|align=center|
OUI
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3110d2.pdf TPA3110]
|align=left|
*Amplification moyenne
*Basses creuses
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3116
|align=center|
[[Fichier:TPA3116.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 50W<br>
2 x 15W
|align=center|
4 Ω<br>
8 Ω
|align=center|
21 V<br>
15 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI<br>
NON
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3116d2.pdf TPA3116]
|align=left|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3118
|align=center|
[[Fichier:TPA3118.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 30W
|align=center|
8 Ω
|align=center|
12 - 24 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI
|align=left|
[http://www.ti.com/lit/ds/symlink/tpa3118d2.pdf TPA3118]
|align=center|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|}
</div>

= Potentiomètre digital =
A faire

= Décodeur MP3 =
==Présentation==
Le décodeur MP3 choisi est le VS1053

[[Fichier:vs1053_board.jpg|centré|200px]]

Ce décodeur offre une interface SPI et permet de lire ainsi que d'enregistrer des fichiers aux formats :
* lecture :
**MP3 ;
**Ogg Vorbis (libre de droit) ;
**PCM;
**WAV;
* enregistrement :
**Ogg Vorbis(libre de droit) ;

==Documentation technique==
Voici la [[:Media:vs1053_doc.pdf|documentation du VS1053]], pour ceux qui voudraient écrire une librairie C++ !

== Schéma ==
Les tests ont été réalisés avec un WemOS D1 mini (ESP8266) :
<div align="center">
{|class="wikitable" width="85%"
! ESP8266 !! VS1053 !! Connections
|-valign=top
||
[[Fichier:wemos_D1_R2_mini_diagram.png|centré|470px]]
||
[[Fichier:vs1053_board_diagram.png|centré|300px]]
|align="center"|
{|class="wikitable"
! ESP8266 !! VS1053
|-
|align="center"| D0
|align="center"| XDCS
|-
|align="center"| D1
|align="center"| XoS (Cable Select)
|-
|align="center"| D3
|align="center"| DREQ
|-
|align="center"| D5
|align="center"| SCK (Serial ClocK)
|-
|align="center"| D6
|align="center"| MISO (Master In Slave Out)
|-
|align="center"| D7
|align="center"| MOSI (Master Out Slave In)
|-
|align="center"| RST
|align="center"| XRST
|-
|align="center"| 5V
|align="center"| 5V
|-
|align="center"| G
|align="center"| DGND
|}
|}
</div>
Vous devriez avoir quelque chose comme ça :

[[Fichier:wemos_D1_vs1053_diagram.jpg|centré|400px]]

== Programmation ==
Tout d'abord un grand merci à [https://github.com/baldram/ESP_VS1053_Library ''baldram''] pour sa [[Media:ESP_VS1053_Library.zip|librairie]] que nous allons utiliser !

Le plus simple est de regarder l'exemple ''SimpleMP3Player'' fourni avec la librairie :
<source lang="c">
// La fameuse librairie de baldram
#include <VS1053.h>
// Un MP3 au format binaire dans un tableau (le fichier est livré avec la librairie)
#include <helloMp3.h>
// Définition des port SPI utilisé (ici pour l'ESP8266)
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
// Définition du volume
#define VOLUME 80 // volume level 0-100
// Création de l'objet VS1053
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);

void setup () {
// Démarrage du SPI
SPI.begin();
// démarrage du VS1053
player.begin();
// Ligne nécessaire pour certain lecteur
player.switchToMp3Mode();
player.setVolume(VOLUME);
}

void loop() {
// On joue le MP3 dans le tableau
player.playChunk(helloMp3, sizeof(helloMp3));
// On attend 3 secondes
delay(3000);
}
</source>
Pour que cet exemple fonctionne, il faut soit copier le contenu de ''HelloMp3.h'' dans le fichier exemple, soit copier le fichier dans le répertoire de la librairie dans votre dossier ''Arduino''.

Une fois la compilation terminée, vous devriez entendre ''du bruit'' sortir du VS1053 !

= Flux musical =
La communication se fera en générant un flux entre le programme (PC) et l'enceinte (ESP8266). Ce flux, pour des raisons de simplicité, se fera en TCP car ce protocole gère les retransmissions, les tampons d'entrée / sortie, etc...

A terme, une application temps réel comme la musique mériterait de passer sur de l'UDP. Surtout que, si l'on souhaite utiliser du [https://www.tala-informatique.fr/wiki/index.php/Esp8266_udp_server multicast], pour parler à un groupe d'enceintes, on ne peut le faire qu'en UDP !
== Envoi : serveur en PHP ==
La partie serveur prend un fichier, ici un MP3, lit un morceau du fichier et l'envoi à l'enceinte à travers une socket TCP. Deux paramètres sont à prendre en compte :
*le temps d'attente entre chaque envoi;
*la taille d'un morceau;
Ces paramètres nécessiteront certainement un temps d'ajustement qui sera en fonction de la latence, la congestion du réseau, les capacités des puces impliquées (ici l'ESP8266), etc...
{|style="width:650px" align="center"
|
[[Fichier:warning-icon.png|centré|60px]]
|valign="top" align="justify"|
Les extraits de code qui vont suivre respectent vaguement les préceptes, au combien importants, de la programmation orientée objet et sont fournis à titre indicatif dans l'unique but de démontrer la faisabilité d'un tel projet ! Voici [[:Media:Iot_Speaker.zip | l'archive]] qui contient le code exposé ci-dessous.
|}
=== MusicSender ===
Voici le contenu du fichier ''MusicSender.class.php'' :
<source lang="php">
<?php

class MusicSender
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5045;

// Le temps d'attente en microsecondes entre chaque paquets
private static $SLEEP_INTERVAL = 2500;

// La taille de chacun des paquets
private static $CHUNK_BUFFER = 32768;

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Envoie le MP3 à l'enceinte
*
* @param string $mp3File
* @return boolean
*/
public function play($mp3File)
{
if (is_file($mp3File)) {
// Ouverture du fichier en lecture binaire
$file = fopen($mp3File, 'rb');
if ($file === FALSE) {
echo "Fail reading file " . $file . "\n";
return FALSE;
}
// Ouverture de la socket
$socket = $this->openSocket();
// Tant qu'on est pas à la fin du fichier
while (! feof($file)) {
// Envoie d'un "morceau" de taille CHUNK_BUFFER à l'enceinte
if (@socket_write($this->socket, fread($file, self::$CHUNK_BUFFER), self::$CHUNK_BUFFER) === FALSE) {
// Problème de socket (fermeture, déconnexion, etc...)
return FALSE;
}
usleep(self::$SLEEP_INTERVAL);
}
// Fermeture de la socket
$this->closeSocket();
// Fermeture du fichier
fclose($file);
return TRUE;
}
echo $file." does not exists !\n";
return FALSE;
}

/**
* Lit tous les mp3 présents dans le dossier
*
* @param string $dir
*/
public function readFolder($dir)
{
if (is_dir($dir)) {
// On récupére les fichiers sans les 2 premiers '.' et '..'
$files = array_slice(scandir($dir), 2);
foreach ($files as $file) {
// On créé le chemin absolu
$mp3File = $dir . DIRECTORY_SEPARATOR . $file;
// On test l'extension
if (pathinfo($file)["extension"] == "mp3") {
$this->play($mp3File);
}
}
return true;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) == FALSE) {
echo "socket_create_listen() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
if (socket_connect($this->socket, $this->ip, self::$PORT) == FALSE) {
echo "socket_bind() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
=== Launch.php ===
On créé un fichier ''Launch.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicSender.class.php';

$esp_ip = "192.168.1.200";

$dir = "!!chemin_vers_des_fichiers_mp3!!";

$sender = new MusicSender($esp_ip);

$sender->readFolder($dir);
</source>

== Réception : ESP8266 ==
{|style="width:650px" align="center"
|
[[Fichier:Warning manual.jpg|centré|300px]]
|valign="top" align="justify"|
Soyez sûr de comprendre la section sur [https://www.tala-informatique.fr/wiki/index.php/Arduino_sketch_writing| comment écrire un sketch] avant de poursuivre. Le code ci-dessous fait référence à des parties bien spécifiques, détaillées et expliquées dans la section suscitée.
|}
=== Partie WiFi ===
La première étape consiste à raccorder notre ''ESP'' au réseau WiFi !
<source lang="c">
#include <ESP8266WiFi.h>
#include <WiFiClient.h>

// WiFi Parameters //
const char ssid[] = "cfcasa";
const char password[] = "***********";
IPAddress ip(192, 168, 1, 200);
IPAddress gw(192, 168, 1, 254);
IPAddress mask(255, 255, 252, 0);

void setup() {
// on démarre le port série
Serial.begin(115200);
// On attend "un peu" que le buffer soit prêt
delay(10);
// On démarre le WiFi
initWiFi();
}

void loop() {
}

void initWiFi() {
// On efface la configuration précédente
WiFi.disconnect(true);
Serial.printf("\nConnexion a %s", ssid);
// Initialisation de la connection
WiFi.config(ip, gw, mask, gw);
WiFi.begin(ssid, password);
// Test pour déterminer quand la connection est prete
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(".");
}
// Affichage des informations
Serial.printf(" connecté\nAdresse IP: %s\n", WiFi.localIP().toString().c_str());
}
</source>
=== Lecteur MP3 ===
Vient ensuite la partie du lecteur MP3. Dans la partie des imports, ajoutez la ligne suivante :
<source lang="c">
#include <VS1053.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Parameters //
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
#define VOLUME 70 // volume level 0-100
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);
uint8_t volume_level = VOLUME;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le shield MP3
initMP3();
</source>
A la suite, on insère la fonction suivante :
<source lang="c">
void initMP3() {
SPI.begin();
// Démarrage du lecteur MP3
player.begin();
player.switchToMp3Mode();
player.setVolume(volume_level);
}
</source>
=== Récupération du stream MP3 ===
On va maintenant récupérer le flux envoyé depuis le serveur. Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Server parameters //
const uint16_t MP3_PORT = 5045;
WiFiServer server(MP3_PORT);
const uint16_t BUFFER_SIZE = 16384;
//const uint16_t BUFFER_SIZE = 32768;
byte buffer[BUFFER_SIZE + 1];
uint16_t byteRead = 0;
bool isBufferReady = false;
WiFiClient client;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur TCP
initMp3Server();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
void initMp3Server() {
// Démarrage du serveur TCP
server.begin();
Serial.printf("Ecoute TCP sur le port %d\n", MP3_PORT);
}

void readMp3() {
// Un client est connecté
if (client) {
// Si le client est toujours connecté...
if (client.connected()) {
// Tant que l'on reçoit de la musique
while (client.available() > 0) {
// On rempli le buffer avec le contenu du paquet TCP
buffer[byteRead++] = client.read();
// Si le buffer est plein
if (byteRead == BUFFER_SIZE) {
// On previent que le buffer est plein
isBufferReady = true;
// On sort de la boucle
break;
}
}
// Si le buffer est plein
if (isBufferReady) {
// On envoi tout au lecteur MP3
player.playChunk(buffer, byteRead);
// On RAZ le compteur de bytes
byteRead = 0;
}
} else {
// Si le client est déconneté
client = server.available();
// On prévient que le buffer est vide
isBufferReady = false;
// On RAZ le compteur de bytes
byteRead = 0;
Serial.println(F("Client disconnected"));
}
} else {
// On test la présence d'un client
client = server.available();
if (client) {
// Un client est connecté !
Serial.println(F("New client !"));
}
}
}
</source>
Enfin, on ajoute le ligne suivante dans la fonction ''loop()'' :
<source lang="c">
readMp3();
</source>
A ce stade, l'ESP devrait être capable de récupérer le flux et de le jouer !

= Envoi de commandes =
Envoyer de la musique c'est bien, pouvoir régler le volume c'est encore mieux !

La façon la plus simple d'adresser le problème c'est d'utiliser un autre port et, comme les messages sont petits, d'utiliser UDP.
== Partie Serveur ==
Dans la même veine, voici la classe qui permet d'envoyer les commandes :
<source lang="php">
<?php

class MusicHandler
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5046;

// Le port de l'enceinte connectée
private static $RETRIES = 3;

// Liste de commandes
private static $CMD_VOLUME = 'V';

private static $CMD_LOCATE = 'L';

private static $CMD_RESET = 'R';

private static $RESPONSE_NOK = 'N';

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Augmente le volume d'un incrément
*
* @return boolean
*/
public function volumeUp()
{
return $this->sendCommand(self::$CMD_VOLUME . "+");
}

/**
* Baisse le volume d'un incrément
*
* @return boolean
*/
public function volumeDown()
{
return $this->sendCommand(self::$CMD_VOLUME . "-");
}

/**
*
* @return boolean
*/
public function setVolume($volume)
{
if ($volume < 0 || $volume > 100) {
return false;
}
return $this->sendCommand(self::$CMD_VOLUME . $volume);
}

public function getVolume(){
return $this->sendCommand(self::$CMD_VOLUME);
}

/**
*
* @return boolean
*/
public function doReset()
{
return $this->sendCommand(self::$CMD_RESET);
}

public function doLocate(){
return $this->sendCommand(self::$CMD_LOCATE);
}

/**
* Envoie une commande au module
*
* @param string $message
*/
private function sendCommand($message)
{
$result = false;
if ($this->openSocket() !== FALSE) {
if (socket_sendto($this->socket, $message, strlen($message), 0, $this->ip, self::$PORT) !== FALSE) {
$result = $this->readAcknoledge();
}
}
$this->closeSocket();
return $result;
}

/**
* Attend la confirmation de la commande
*
* @return boolean
*/
private function readAcknoledge()
{
$buf = "";
$retries = 0;
while ($retries < self::$RETRIES) {
$byteReceived = socket_recvfrom($this->socket, $buf, 2048, 0, $this->ip, self::$PORT);
if ($byteReceived > 0) {
return $buf != self::$RESPONSE_NOK ? $buf : FALSE;
}
usleep(500000);
$retries ++;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) === FALSE) {
$errorcode = socket_last_error();
$errormsg = socket_strerror($errorcode);
echo ("Couldn't create socket: [$errorcode] $errormsg \n");
return false;
}
return true;
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
On créé un fichier ''Command.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicHandler.class.php';

$esp_ip = "192.168.1.200";

$handler = new MusicHandler($esp_ip);

// Exemple de commandes //
//$result = $handler->volumeUp();
//$result = $handler->getVolume();
//$result = $handler->doReset();
//$result = $handler->setVolume(70);

$result = $handler->doLocate();

echo $result !== FALSE ? "ok : $result\n" : "nok\n";
</source>
== Partie Cliente ==
Dans la partie des imports ajoutez la ligne suivante :
<source lang="c">
#include <WiFiUDP.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// Command Server parameters //
const uint16_t CMD_PORT = 5046;
// L'instance du serveur UDP
WiFiUDP udp;
// Liste de commandes
const char CMD_VOLUME = 'V';
const char CMD_LOCATE = 'L';
const char CMD_RESET = 'R';
const char RESPONSE_NOK[] = "N";

// Localisation parameters
uint8_t ledPin = LED_BUILTIN;
const uint16_t BLINK_FREQ = 500;
const uint8_t BLINK_REP = 60;
uint8_t repetition = 0;
uint32_t timer;
bool isLocate = false;
</source>
A la fin de la fonction setup() nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur UDP
initCmdServer();
// On prépare la led de localisation
initLocateLed();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
bool readCmd() {
if (udp.parsePacket() > 0) {
uint8_t len = udp.available();
char c = udp.read();
if (len == 1) {
if (c == CMD_RESET) {
player.softReset();
sendPacket(CMD_RESET);
return true;
} else if (c == CMD_VOLUME) {
sendPacket(volume_level);
return true;
} else if (c == CMD_LOCATE) {
if (!isLocate) {
locate(true);
sendPacket(CMD_LOCATE);
return true;
}
}
} else if (len == 2) {
char value = udp.read();
if (c == CMD_VOLUME) {
if (value == '+' && volume_level != 100) {
setVolume(volume_level + 1);
} else if (value == '-' && volume_level != 0) {
setVolume(volume_level - 1);
} else {
sendNack();
return false;
}
return true;
}
} else {
if (c == CMD_VOLUME) {
char value[4] = "0";
udp.read(value, 3);
uint8_t vol = atoi(value);
if (vol >= 0 && vol <= 100) {
setVolume(vol);
return true;
}
}
}
sendNack();
return false;
}
// Check if locate needs to be done
locate(false);
}
void locate(bool blink) {
if (blink) {
// Initialisation des variables
digitalWrite(ledPin, LOW);
isLocate = true;
repetition = 0;
timer = millis();
} else if (isLocate) {
// Calcule du temps
uint32_t elapsed = millis() - timer;
if (elapsed > BLINK_FREQ) {
repetition++;
if (repetition == BLINK_REP) {
// On a atteint le nombre de clignotements
isLocate = false;
digitalWrite(ledPin, HIGH);
} else {
// On fait clignoter la led
digitalWrite(ledPin, !digitalRead(ledPin));
timer = millis();
}
}
}
}

void setVolume(uint8_t vol) {
volume_level = vol;
Serial.printf("Setting volume to %d\n", volume_level);
player.setVolume(volume_level);
sendPacket(volume_level);
}

void sendNack() {
sendPacket(RESPONSE_NOK);
}

void sendPacket(const char content) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(const char content[]) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(int content) {
char value[4];
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(itoa(content, value, 10));
udp.endPacket();
}

void initCmdServer() {
// Démarrage du serveur TCP
udp.begin(CMD_PORT);
Serial.printf("Ecoute UDP sur le port %d\n", CMD_PORT);
}

void initLocateLed() {
pinMode(ledPin, OUTPUT);
digitalWrite(ledPin, HIGH);
}
</source>
L'ESP est maintenant capable de :
* monter / baisser le volume ;
* de faire un reset du lecteur MP3 (en cas de problème)
* de faire clignoter sa led pour être localisé facilement.

= Enceinte armbian =
Même objectif mais cette fois-ci avec Rygel, un lecteur DLNA.
==Installation ==
Le système:
<pre>
# apt-get update
</pre>
Le lecteur rygel:
<pre>
# apt-get -y install rygel-playbin
</pre>
Les différents plugins. Tout d'abord, récupérer les plugins en fonctions de la distribution:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | awk -F ' - ' '{print $1}')
# apt-get install ${plugins}
</pre>
Ensuite on procéde à l'installation:
<pre>
# apt-get install ${plugins}
</pre>
== Création du fichier de service ==
Il suffit de créer le fichier ''/etc/systemd/system/rygel.service'':
<pre>
[Unit]
Description=Rygel service
After=network-online.target

[Service]
Type=simple
UMask=007
ExecStart=/usr/bin/rygel -g 5
Restart=on-failure

# Configures the time to wait before service is stopped forcefully.
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
On peut lancer le service et l'activer au démarrage
<pre>
# systemctl start rygel
# systemctl enable rygel
</pre>
== Désactivation des logs ==
Comme l'enceinte n'est pas à proprement parler un serveur exécutant un service critique, on peut désactiver le système de logging pour économiser la durée de vie de la carte SD:
<pre>
# systemctl stop rsyslog
# systemctl disable rsyslog
</pre>
== Ajustement du volume ==
Il faut maintenant mettre le volume au maximum coté Pi avec le mixer ALSA [https://fr.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture wikipedia] :
<pre>
# alsamixer
</pre>
[[Fichier:alsamixer armbian.png|centré]]
== Changement de la carte son par défaut ==
Une fois la carte son USB installée, il suffit d'utiliser la commande suivante pour voir son identifiant:
<pre>
# aplay -l
**** List of PLAYBACK Hardware Devices ****
card 0: sun4icodec [sun4i-codec], device 0: CDC PCM Codec-0 []
Subdevices: 1/1
Subdevice #0: subdevice #0
card 1: Device [USB Audio Device], device 0: USB Audio [USB Audio]
Subdevices: 0/1
Subdevice #0: subdevice #0
</pre>
La carte son avec l'ID ''0'' est celle intégrée au PI, celle avec l'ID ''1'' est la carte USB.
Pour dire à ALSA que c'est la carte avec l'ID ''1'' que l'on veut par défaut, il suffit de créer le fichier ''/etc/asound.conf'' avec les lignes suivantes:
<pre>
defaults.pcm.card 1
defaults.ctl.card 1
</pre>
La configuration est appliquée après un redémarrage !

== WiringPI==
===Installation===
<pre>
# cd /opt
# git clone https://github.com/LeMaker/WiringLMK.git
# cd WiringLMK
# chmod +x ./build
# ./build
</pre>

=== Utilisation===
Pour la lecture des états
<pre>
# gpio readall
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| | | 3.3v | | | 1 || 2 | | | 5v | | |
| 2 | 8 | SDA.1 | ALT5 | 0 | 3 || 4 | | | 5V | | |
| 3 | 9 | SCL.1 | ALT5 | 0 | 5 || 6 | | | 0v | | |
| 4 | 7 | GPIO. 7 | IN | 0 | 7 || 8 | 1 | ALT2 | TxD | 15 | 14 |
| | | 0v | | | 9 || 10 | 0 | IN | RxD | 16 | 15 |
| 17 | 0 | GPIO. 0 | IN | 0 | 11 || 12 | 0 | IN | GPIO. 1 | 1 | 18 |
| 27 | 2 | GPIO. 2 | IN | 0 | 13 || 14 | | | 0v | | |
| 22 | 3 | GPIO. 3 | IN | 0 | 15 || 16 | 0 | IN | GPIO. 4 | 4 | 23 |
| | | 3.3v | | | 17 || 18 | 0 | IN | GPIO. 5 | 5 | 24 |
| 10 | 12 | MOSI | ALT5 | 0 | 19 || 20 | | | 0v | | |
| 9 | 13 | MISO | ALT5 | 0 | 21 || 22 | 0 | IN | GPIO. 6 | 6 | 25 |
| 11 | 14 | SCLK | ALT5 | 0 | 23 || 24 | 0 | ALT5 | CE0 | 10 | 8 |
| | | 0v | | | 25 || 26 | 0 | ALT5 | CE1 | 11 | 7 |
| 0 | 30 | SDA.0 | IN | 1 | 27 || 28 | 1 | IN | SCL.0 | 31 | 1 |
| 5 | 21 | GPIO.21 | IN | 0 | 29 || 30 | | | 0v | | |
| 6 | 22 | GPIO.22 | ALT4 | 0 | 31 || 32 | 0 | ALT4 | GPIO.26 | 26 | 12 |
| 13 | 23 | GPIO.23 | IN | 0 | 33 || 34 | | | 0v | | |
| 19 | 24 | GPIO.24 | IN | 0 | 35 || 36 | 0 | IN | GPIO.27 | 27 | 16 |
| 26 | 25 | GPIO.25 | IN | 0 | 37 || 38 | 0 | IN | GPIO.28 | 28 | 20 |
| | | 0v | | | 39 || 40 | 0 | IN | GPIO.29 | 29 | 21 |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
</pre>
Ou d'un état:
<pre>
# gpio read 1
0
</pre>
Changement d'état:
<pre>
# gpio -1 write 8 0
</pre>

== Détection de musique ==
Il est possible de détecter si de la musique est en train d'être jouée sur le PI grâce à la commande suivante:
<pre>
# cat /proc/asound/card*/pcm*/sub*/status | grep RUNNING | wc -l
</pre>
Si cette commande renvoie ''1'' cela veut dire que ''state: RUNNING'' est présent dans un des fichiers d'une des cartes son.

Cette commande peu permettre de piloter un amplificateur au travers d'un relais piloté par une GPIO...

== Ajout du bluetooth ==
Il faut d'abord installer blueZ:
<pre>
# apt-get install -y bluez bluez-tools
</pre>

Iot speaker

2019-07-17T03:09:03Z

Tala : /* Ajout du bluetooth */

=Projet=
{|class="wikitable" width="100%"
|-valign=top
! Objectif !! Les acteurs !! Compétences !! Matériel
|-valign=top
||
Construire des enceintes sans-fils (sauf le courant) actives connectées capables de travailler en "groupe"
||
*[[User:Tala | Tala]]
*[[User:Nigdor |Nigdor]]
*[[User:Prandar |Prandar]]
||
*électronique
*C++ (microcontrôleur)
||
* microcontrôleur (esp8266)
* amplificateur audio (XPT8871, PAM8403, ...)
* décodeur MP3 (VS1053B)
* potentiomètre digital (X9C103S)
|}

= Choix de l'amplificateur =
A faire:
*Expliquer la différence entre classe AB et D (qualité sonore vs. éco énergie)
*Faire un tableau récapitulatif des caractéristiques des amplis:
** mono / stéréo / les deux
** tension de fonctionnement / consommation (5v, 12v, 24v, etc...)
** puissance (5w, 20w, 30w, etc...)
** impédance de sortie (2 x 4Ω, 1 x 8Ω, etc...)
** réponse fréquentielle ;
** résistance aux courts-circuits ;
** bruit pop (quand pas de musique);
** besoin d'un dissipateur ou non (effet joule à prévoir...)
** lien vers la documentation si besoin d'info(eg. pour le [https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932])
** le plus important : le ressenti !
==Classe AB==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
TDA7297
|align=center|
[[Fichier:TDA7297.png|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 15W
|align=center|
2A (peak)
|align=center|
6 - 18 V
|align=center|
OUI
|align=center|
Avec µControlleur<br>(p. 3/4)
|align=center|
Obligatoire
|align=center|
[http://www.st.com/content/ccc/resource/technical/document/datasheet/a3/eb/9b/59/dd/26/4a/27/CD00001048.pdf/files/CD00001048.pdf/jcr:content/translations/en.CD00001048.pdf TDA7297]
|align=left|
Super amplification sans distorsion !
<br>
Forte dissipation thermique à pleine puissance :
* 33W d'après la doc;
* vraiment très (trop) fort !
|}
</div>

==Classe D==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
XH-M531 (YDA138)
|align=center|
[[Fichier:XH-M531.jpg|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 10 W<br>
2 x 20 W
|align=center|
8 Ω<br>
4 Ω
|align=center|
12 - 15V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.ksp-electronics.com/product_files/8eeedc66ea8fbcdf2e74294037c2f389 YDA138]
|align=center|
|-valign="top"
|align=center|
PAM8403
|align=center|
[[Fichier:PAM8403.jpg|centré|100px]]
|align=center|
Stéréo
|align=center|
3W(*2 ?)
|align=center|
4 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
Reduit mais présent
|align=center|
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8403.pdf PAM8403]
|align=center|
|-valign="top"
|align=center|
PAM8610
|align=center|
[[Fichier:PAM8610.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 10 W
|align=center|
8 Ω
|align=center|
7 - 15 V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8610.pdf PAM8610]
|align=center|
|-valign="top"
|align=center|
XPT8871
|align=center|
[[Fichier:XPT8871.jpg|centré|120px]]
|align=center|
Mono
|align=center|
3.5w
<br>
5w
|align=center|
3 Ω
<br>
2 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[[Media:XPT8871.pdf|XPT8871]]
|align=left|
*Bien pour la voix, pas top pour la musique
|-valign="top"
|align=center|
TDA8932
|align=center|
[[Fichier:TDA8932.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2*15W
|align=center|
4 Ω
|align=center|
Entre 10 V et 36 V (Rechercher quel est le plus optimal)
|align=center|
OUI
|align=center|
NON
|align=center|

|align=center|
[https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932]
|align=center|
|-valign="top"
|align=center|
TPA3110
|align=center|
[[Fichier:TPA3110.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
15W/ch
|align=center|
8 Ω
|align=center|
16 V
|align=center|
OUI
|align=center|
NON
|align=center|
OUI
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3110d2.pdf TPA3110]
|align=left|
*Amplification moyenne
*Basses creuses
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3116
|align=center|
[[Fichier:TPA3116.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 50W<br>
2 x 15W
|align=center|
4 Ω<br>
8 Ω
|align=center|
21 V<br>
15 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI<br>
NON
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3116d2.pdf TPA3116]
|align=left|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3118
|align=center|
[[Fichier:TPA3118.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 30W
|align=center|
8 Ω
|align=center|
12 - 24 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI
|align=left|
[http://www.ti.com/lit/ds/symlink/tpa3118d2.pdf TPA3118]
|align=center|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|}
</div>

= Potentiomètre digital =
A faire

= Décodeur MP3 =
==Présentation==
Le décodeur MP3 choisi est le VS1053

[[Fichier:vs1053_board.jpg|centré|200px]]

Ce décodeur offre une interface SPI et permet de lire ainsi que d'enregistrer des fichiers aux formats :
* lecture :
**MP3 ;
**Ogg Vorbis (libre de droit) ;
**PCM;
**WAV;
* enregistrement :
**Ogg Vorbis(libre de droit) ;

==Documentation technique==
Voici la [[:Media:vs1053_doc.pdf|documentation du VS1053]], pour ceux qui voudraient écrire une librairie C++ !

== Schéma ==
Les tests ont été réalisés avec un WemOS D1 mini (ESP8266) :
<div align="center">
{|class="wikitable" width="85%"
! ESP8266 !! VS1053 !! Connections
|-valign=top
||
[[Fichier:wemos_D1_R2_mini_diagram.png|centré|470px]]
||
[[Fichier:vs1053_board_diagram.png|centré|300px]]
|align="center"|
{|class="wikitable"
! ESP8266 !! VS1053
|-
|align="center"| D0
|align="center"| XDCS
|-
|align="center"| D1
|align="center"| XoS (Cable Select)
|-
|align="center"| D3
|align="center"| DREQ
|-
|align="center"| D5
|align="center"| SCK (Serial ClocK)
|-
|align="center"| D6
|align="center"| MISO (Master In Slave Out)
|-
|align="center"| D7
|align="center"| MOSI (Master Out Slave In)
|-
|align="center"| RST
|align="center"| XRST
|-
|align="center"| 5V
|align="center"| 5V
|-
|align="center"| G
|align="center"| DGND
|}
|}
</div>
Vous devriez avoir quelque chose comme ça :

[[Fichier:wemos_D1_vs1053_diagram.jpg|centré|400px]]

== Programmation ==
Tout d'abord un grand merci à [https://github.com/baldram/ESP_VS1053_Library ''baldram''] pour sa [[Media:ESP_VS1053_Library.zip|librairie]] que nous allons utiliser !

Le plus simple est de regarder l'exemple ''SimpleMP3Player'' fourni avec la librairie :
<source lang="c">
// La fameuse librairie de baldram
#include <VS1053.h>
// Un MP3 au format binaire dans un tableau (le fichier est livré avec la librairie)
#include <helloMp3.h>
// Définition des port SPI utilisé (ici pour l'ESP8266)
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
// Définition du volume
#define VOLUME 80 // volume level 0-100
// Création de l'objet VS1053
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);

void setup () {
// Démarrage du SPI
SPI.begin();
// démarrage du VS1053
player.begin();
// Ligne nécessaire pour certain lecteur
player.switchToMp3Mode();
player.setVolume(VOLUME);
}

void loop() {
// On joue le MP3 dans le tableau
player.playChunk(helloMp3, sizeof(helloMp3));
// On attend 3 secondes
delay(3000);
}
</source>
Pour que cet exemple fonctionne, il faut soit copier le contenu de ''HelloMp3.h'' dans le fichier exemple, soit copier le fichier dans le répertoire de la librairie dans votre dossier ''Arduino''.

Une fois la compilation terminée, vous devriez entendre ''du bruit'' sortir du VS1053 !

= Flux musical =
La communication se fera en générant un flux entre le programme (PC) et l'enceinte (ESP8266). Ce flux, pour des raisons de simplicité, se fera en TCP car ce protocole gère les retransmissions, les tampons d'entrée / sortie, etc...

A terme, une application temps réel comme la musique mériterait de passer sur de l'UDP. Surtout que, si l'on souhaite utiliser du [https://www.tala-informatique.fr/wiki/index.php/Esp8266_udp_server multicast], pour parler à un groupe d'enceintes, on ne peut le faire qu'en UDP !
== Envoi : serveur en PHP ==
La partie serveur prend un fichier, ici un MP3, lit un morceau du fichier et l'envoi à l'enceinte à travers une socket TCP. Deux paramètres sont à prendre en compte :
*le temps d'attente entre chaque envoi;
*la taille d'un morceau;
Ces paramètres nécessiteront certainement un temps d'ajustement qui sera en fonction de la latence, la congestion du réseau, les capacités des puces impliquées (ici l'ESP8266), etc...
{|style="width:650px" align="center"
|
[[Fichier:warning-icon.png|centré|60px]]
|valign="top" align="justify"|
Les extraits de code qui vont suivre respectent vaguement les préceptes, au combien importants, de la programmation orientée objet et sont fournis à titre indicatif dans l'unique but de démontrer la faisabilité d'un tel projet ! Voici [[:Media:Iot_Speaker.zip | l'archive]] qui contient le code exposé ci-dessous.
|}
=== MusicSender ===
Voici le contenu du fichier ''MusicSender.class.php'' :
<source lang="php">
<?php

class MusicSender
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5045;

// Le temps d'attente en microsecondes entre chaque paquets
private static $SLEEP_INTERVAL = 2500;

// La taille de chacun des paquets
private static $CHUNK_BUFFER = 32768;

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Envoie le MP3 à l'enceinte
*
* @param string $mp3File
* @return boolean
*/
public function play($mp3File)
{
if (is_file($mp3File)) {
// Ouverture du fichier en lecture binaire
$file = fopen($mp3File, 'rb');
if ($file === FALSE) {
echo "Fail reading file " . $file . "\n";
return FALSE;
}
// Ouverture de la socket
$socket = $this->openSocket();
// Tant qu'on est pas à la fin du fichier
while (! feof($file)) {
// Envoie d'un "morceau" de taille CHUNK_BUFFER à l'enceinte
if (@socket_write($this->socket, fread($file, self::$CHUNK_BUFFER), self::$CHUNK_BUFFER) === FALSE) {
// Problème de socket (fermeture, déconnexion, etc...)
return FALSE;
}
usleep(self::$SLEEP_INTERVAL);
}
// Fermeture de la socket
$this->closeSocket();
// Fermeture du fichier
fclose($file);
return TRUE;
}
echo $file." does not exists !\n";
return FALSE;
}

/**
* Lit tous les mp3 présents dans le dossier
*
* @param string $dir
*/
public function readFolder($dir)
{
if (is_dir($dir)) {
// On récupére les fichiers sans les 2 premiers '.' et '..'
$files = array_slice(scandir($dir), 2);
foreach ($files as $file) {
// On créé le chemin absolu
$mp3File = $dir . DIRECTORY_SEPARATOR . $file;
// On test l'extension
if (pathinfo($file)["extension"] == "mp3") {
$this->play($mp3File);
}
}
return true;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) == FALSE) {
echo "socket_create_listen() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
if (socket_connect($this->socket, $this->ip, self::$PORT) == FALSE) {
echo "socket_bind() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
=== Launch.php ===
On créé un fichier ''Launch.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicSender.class.php';

$esp_ip = "192.168.1.200";

$dir = "!!chemin_vers_des_fichiers_mp3!!";

$sender = new MusicSender($esp_ip);

$sender->readFolder($dir);
</source>

== Réception : ESP8266 ==
{|style="width:650px" align="center"
|
[[Fichier:Warning manual.jpg|centré|300px]]
|valign="top" align="justify"|
Soyez sûr de comprendre la section sur [https://www.tala-informatique.fr/wiki/index.php/Arduino_sketch_writing| comment écrire un sketch] avant de poursuivre. Le code ci-dessous fait référence à des parties bien spécifiques, détaillées et expliquées dans la section suscitée.
|}
=== Partie WiFi ===
La première étape consiste à raccorder notre ''ESP'' au réseau WiFi !
<source lang="c">
#include <ESP8266WiFi.h>
#include <WiFiClient.h>

// WiFi Parameters //
const char ssid[] = "cfcasa";
const char password[] = "***********";
IPAddress ip(192, 168, 1, 200);
IPAddress gw(192, 168, 1, 254);
IPAddress mask(255, 255, 252, 0);

void setup() {
// on démarre le port série
Serial.begin(115200);
// On attend "un peu" que le buffer soit prêt
delay(10);
// On démarre le WiFi
initWiFi();
}

void loop() {
}

void initWiFi() {
// On efface la configuration précédente
WiFi.disconnect(true);
Serial.printf("\nConnexion a %s", ssid);
// Initialisation de la connection
WiFi.config(ip, gw, mask, gw);
WiFi.begin(ssid, password);
// Test pour déterminer quand la connection est prete
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(".");
}
// Affichage des informations
Serial.printf(" connecté\nAdresse IP: %s\n", WiFi.localIP().toString().c_str());
}
</source>
=== Lecteur MP3 ===
Vient ensuite la partie du lecteur MP3. Dans la partie des imports, ajoutez la ligne suivante :
<source lang="c">
#include <VS1053.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Parameters //
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
#define VOLUME 70 // volume level 0-100
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);
uint8_t volume_level = VOLUME;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le shield MP3
initMP3();
</source>
A la suite, on insère la fonction suivante :
<source lang="c">
void initMP3() {
SPI.begin();
// Démarrage du lecteur MP3
player.begin();
player.switchToMp3Mode();
player.setVolume(volume_level);
}
</source>
=== Récupération du stream MP3 ===
On va maintenant récupérer le flux envoyé depuis le serveur. Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Server parameters //
const uint16_t MP3_PORT = 5045;
WiFiServer server(MP3_PORT);
const uint16_t BUFFER_SIZE = 16384;
//const uint16_t BUFFER_SIZE = 32768;
byte buffer[BUFFER_SIZE + 1];
uint16_t byteRead = 0;
bool isBufferReady = false;
WiFiClient client;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur TCP
initMp3Server();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
void initMp3Server() {
// Démarrage du serveur TCP
server.begin();
Serial.printf("Ecoute TCP sur le port %d\n", MP3_PORT);
}

void readMp3() {
// Un client est connecté
if (client) {
// Si le client est toujours connecté...
if (client.connected()) {
// Tant que l'on reçoit de la musique
while (client.available() > 0) {
// On rempli le buffer avec le contenu du paquet TCP
buffer[byteRead++] = client.read();
// Si le buffer est plein
if (byteRead == BUFFER_SIZE) {
// On previent que le buffer est plein
isBufferReady = true;
// On sort de la boucle
break;
}
}
// Si le buffer est plein
if (isBufferReady) {
// On envoi tout au lecteur MP3
player.playChunk(buffer, byteRead);
// On RAZ le compteur de bytes
byteRead = 0;
}
} else {
// Si le client est déconneté
client = server.available();
// On prévient que le buffer est vide
isBufferReady = false;
// On RAZ le compteur de bytes
byteRead = 0;
Serial.println(F("Client disconnected"));
}
} else {
// On test la présence d'un client
client = server.available();
if (client) {
// Un client est connecté !
Serial.println(F("New client !"));
}
}
}
</source>
Enfin, on ajoute le ligne suivante dans la fonction ''loop()'' :
<source lang="c">
readMp3();
</source>
A ce stade, l'ESP devrait être capable de récupérer le flux et de le jouer !

= Envoi de commandes =
Envoyer de la musique c'est bien, pouvoir régler le volume c'est encore mieux !

La façon la plus simple d'adresser le problème c'est d'utiliser un autre port et, comme les messages sont petits, d'utiliser UDP.
== Partie Serveur ==
Dans la même veine, voici la classe qui permet d'envoyer les commandes :
<source lang="php">
<?php

class MusicHandler
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5046;

// Le port de l'enceinte connectée
private static $RETRIES = 3;

// Liste de commandes
private static $CMD_VOLUME = 'V';

private static $CMD_LOCATE = 'L';

private static $CMD_RESET = 'R';

private static $RESPONSE_NOK = 'N';

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Augmente le volume d'un incrément
*
* @return boolean
*/
public function volumeUp()
{
return $this->sendCommand(self::$CMD_VOLUME . "+");
}

/**
* Baisse le volume d'un incrément
*
* @return boolean
*/
public function volumeDown()
{
return $this->sendCommand(self::$CMD_VOLUME . "-");
}

/**
*
* @return boolean
*/
public function setVolume($volume)
{
if ($volume < 0 || $volume > 100) {
return false;
}
return $this->sendCommand(self::$CMD_VOLUME . $volume);
}

public function getVolume(){
return $this->sendCommand(self::$CMD_VOLUME);
}

/**
*
* @return boolean
*/
public function doReset()
{
return $this->sendCommand(self::$CMD_RESET);
}

public function doLocate(){
return $this->sendCommand(self::$CMD_LOCATE);
}

/**
* Envoie une commande au module
*
* @param string $message
*/
private function sendCommand($message)
{
$result = false;
if ($this->openSocket() !== FALSE) {
if (socket_sendto($this->socket, $message, strlen($message), 0, $this->ip, self::$PORT) !== FALSE) {
$result = $this->readAcknoledge();
}
}
$this->closeSocket();
return $result;
}

/**
* Attend la confirmation de la commande
*
* @return boolean
*/
private function readAcknoledge()
{
$buf = "";
$retries = 0;
while ($retries < self::$RETRIES) {
$byteReceived = socket_recvfrom($this->socket, $buf, 2048, 0, $this->ip, self::$PORT);
if ($byteReceived > 0) {
return $buf != self::$RESPONSE_NOK ? $buf : FALSE;
}
usleep(500000);
$retries ++;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) === FALSE) {
$errorcode = socket_last_error();
$errormsg = socket_strerror($errorcode);
echo ("Couldn't create socket: [$errorcode] $errormsg \n");
return false;
}
return true;
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
On créé un fichier ''Command.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicHandler.class.php';

$esp_ip = "192.168.1.200";

$handler = new MusicHandler($esp_ip);

// Exemple de commandes //
//$result = $handler->volumeUp();
//$result = $handler->getVolume();
//$result = $handler->doReset();
//$result = $handler->setVolume(70);

$result = $handler->doLocate();

echo $result !== FALSE ? "ok : $result\n" : "nok\n";
</source>
== Partie Cliente ==
Dans la partie des imports ajoutez la ligne suivante :
<source lang="c">
#include <WiFiUDP.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// Command Server parameters //
const uint16_t CMD_PORT = 5046;
// L'instance du serveur UDP
WiFiUDP udp;
// Liste de commandes
const char CMD_VOLUME = 'V';
const char CMD_LOCATE = 'L';
const char CMD_RESET = 'R';
const char RESPONSE_NOK[] = "N";

// Localisation parameters
uint8_t ledPin = LED_BUILTIN;
const uint16_t BLINK_FREQ = 500;
const uint8_t BLINK_REP = 60;
uint8_t repetition = 0;
uint32_t timer;
bool isLocate = false;
</source>
A la fin de la fonction setup() nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur UDP
initCmdServer();
// On prépare la led de localisation
initLocateLed();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
bool readCmd() {
if (udp.parsePacket() > 0) {
uint8_t len = udp.available();
char c = udp.read();
if (len == 1) {
if (c == CMD_RESET) {
player.softReset();
sendPacket(CMD_RESET);
return true;
} else if (c == CMD_VOLUME) {
sendPacket(volume_level);
return true;
} else if (c == CMD_LOCATE) {
if (!isLocate) {
locate(true);
sendPacket(CMD_LOCATE);
return true;
}
}
} else if (len == 2) {
char value = udp.read();
if (c == CMD_VOLUME) {
if (value == '+' && volume_level != 100) {
setVolume(volume_level + 1);
} else if (value == '-' && volume_level != 0) {
setVolume(volume_level - 1);
} else {
sendNack();
return false;
}
return true;
}
} else {
if (c == CMD_VOLUME) {
char value[4] = "0";
udp.read(value, 3);
uint8_t vol = atoi(value);
if (vol >= 0 && vol <= 100) {
setVolume(vol);
return true;
}
}
}
sendNack();
return false;
}
// Check if locate needs to be done
locate(false);
}
void locate(bool blink) {
if (blink) {
// Initialisation des variables
digitalWrite(ledPin, LOW);
isLocate = true;
repetition = 0;
timer = millis();
} else if (isLocate) {
// Calcule du temps
uint32_t elapsed = millis() - timer;
if (elapsed > BLINK_FREQ) {
repetition++;
if (repetition == BLINK_REP) {
// On a atteint le nombre de clignotements
isLocate = false;
digitalWrite(ledPin, HIGH);
} else {
// On fait clignoter la led
digitalWrite(ledPin, !digitalRead(ledPin));
timer = millis();
}
}
}
}

void setVolume(uint8_t vol) {
volume_level = vol;
Serial.printf("Setting volume to %d\n", volume_level);
player.setVolume(volume_level);
sendPacket(volume_level);
}

void sendNack() {
sendPacket(RESPONSE_NOK);
}

void sendPacket(const char content) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(const char content[]) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(int content) {
char value[4];
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(itoa(content, value, 10));
udp.endPacket();
}

void initCmdServer() {
// Démarrage du serveur TCP
udp.begin(CMD_PORT);
Serial.printf("Ecoute UDP sur le port %d\n", CMD_PORT);
}

void initLocateLed() {
pinMode(ledPin, OUTPUT);
digitalWrite(ledPin, HIGH);
}
</source>
L'ESP est maintenant capable de :
* monter / baisser le volume ;
* de faire un reset du lecteur MP3 (en cas de problème)
* de faire clignoter sa led pour être localisé facilement.

= Enceinte armbian =
Même objectif mais cette fois-ci avec Rygel, un lecteur DLNA.
==Installation ==
Le système:
<pre>
# apt-get update
</pre>
Le lecteur rygel:
<pre>
# apt-get -y install rygel-playbin
</pre>
Les différents plugins. Tout d'abord, récupérer les plugins en fonctions de la distribution:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | awk -F ' - ' '{print $1}')
# apt-get install ${plugins}
</pre>
Ensuite on procéde à l'installation:
<pre>
# apt-get install ${plugins}
</pre>
== Création du fichier de service ==
Il suffit de créer le fichier ''/etc/systemd/system/rygel.service'':
<pre>
[Unit]
Description=Rygel service
After=network-online.target

[Service]
Type=simple
UMask=007
ExecStart=/usr/bin/rygel -g 5
Restart=on-failure

# Configures the time to wait before service is stopped forcefully.
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
On peut lancer le service et l'activer au démarrage
<pre>
# systemctl start rygel
# systemctl enable rygel
</pre>
== Désactivation des logs ==
Comme l'enceinte n'est pas à proprement parler un serveur exécutant un service critique, on peut désactiver le système de logging pour économiser la durée de vie de la carte SD:
<pre>
# systemctl stop rsyslog
# systemctl disable rsyslog
</pre>
== Ajustement du volume ==
Il faut maintenant mettre le volume au maximum coté Pi avec le mixer ALSA [https://fr.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture wikipedia] :
<pre>
# alsamixer
</pre>
[[Fichier:alsamixer armbian.png|centré]]
== Changement de la carte son par défaut ==
Une fois la carte son USB installée, il suffit d'utiliser la commande suivante pour voir son identifiant:
<pre>
# aplay -l
**** List of PLAYBACK Hardware Devices ****
card 0: sun4icodec [sun4i-codec], device 0: CDC PCM Codec-0 []
Subdevices: 1/1
Subdevice #0: subdevice #0
card 1: Device [USB Audio Device], device 0: USB Audio [USB Audio]
Subdevices: 0/1
Subdevice #0: subdevice #0
</pre>
La carte son avec l'ID ''0'' est celle intégrée au PI, celle avec l'ID ''1'' est la carte USB.
Pour dire à ALSA que c'est la carte avec l'ID ''1'' que l'on veut par défaut, il suffit de créer le fichier ''/etc/asound.conf'' avec les lignes suivantes:
<pre>
defaults.pcm.card 1
defaults.ctl.card 1
</pre>
La configuration est appliquée après un redémarrage !

== WiringPI==
===Installation===
<pre>
# cd /opt
# git clone https://github.com/LeMaker/WiringLMK.git
# cd WiringLMK
# chmod +x ./build
# ./build
</pre>

=== Utilisation===
Pour la lecture des états
<pre>
# gpio readall
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| | | 3.3v | | | 1 || 2 | | | 5v | | |
| 2 | 8 | SDA.1 | ALT5 | 0 | 3 || 4 | | | 5V | | |
| 3 | 9 | SCL.1 | ALT5 | 0 | 5 || 6 | | | 0v | | |
| 4 | 7 | GPIO. 7 | IN | 0 | 7 || 8 | 1 | ALT2 | TxD | 15 | 14 |
| | | 0v | | | 9 || 10 | 0 | IN | RxD | 16 | 15 |
| 17 | 0 | GPIO. 0 | IN | 0 | 11 || 12 | 0 | IN | GPIO. 1 | 1 | 18 |
| 27 | 2 | GPIO. 2 | IN | 0 | 13 || 14 | | | 0v | | |
| 22 | 3 | GPIO. 3 | IN | 0 | 15 || 16 | 0 | IN | GPIO. 4 | 4 | 23 |
| | | 3.3v | | | 17 || 18 | 0 | IN | GPIO. 5 | 5 | 24 |
| 10 | 12 | MOSI | ALT5 | 0 | 19 || 20 | | | 0v | | |
| 9 | 13 | MISO | ALT5 | 0 | 21 || 22 | 0 | IN | GPIO. 6 | 6 | 25 |
| 11 | 14 | SCLK | ALT5 | 0 | 23 || 24 | 0 | ALT5 | CE0 | 10 | 8 |
| | | 0v | | | 25 || 26 | 0 | ALT5 | CE1 | 11 | 7 |
| 0 | 30 | SDA.0 | IN | 1 | 27 || 28 | 1 | IN | SCL.0 | 31 | 1 |
| 5 | 21 | GPIO.21 | IN | 0 | 29 || 30 | | | 0v | | |
| 6 | 22 | GPIO.22 | ALT4 | 0 | 31 || 32 | 0 | ALT4 | GPIO.26 | 26 | 12 |
| 13 | 23 | GPIO.23 | IN | 0 | 33 || 34 | | | 0v | | |
| 19 | 24 | GPIO.24 | IN | 0 | 35 || 36 | 0 | IN | GPIO.27 | 27 | 16 |
| 26 | 25 | GPIO.25 | IN | 0 | 37 || 38 | 0 | IN | GPIO.28 | 28 | 20 |
| | | 0v | | | 39 || 40 | 0 | IN | GPIO.29 | 29 | 21 |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
</pre>
Ou d'un état:
<pre>
# gpio read 1
0
</pre>
Changement d'état:
<pre>
# gpio -1 write 8 0
</pre>

== Détection de musique ==
Il est possible de détecter si de la musique est en train d'être jouée sur le PI grâce à la commande suivante:
<pre>
# cat /proc/asound/card*/pcm*/sub*/status | grep RUNNING | wc -l
</pre>
Si cette commande renvoie ''1'' cela veut dire que ''state: RUNNING'' est présent dans un des fichiers d'une des cartes son.

Cette commande peu permettre de piloter un amplificateur...
== Ajout du bluetooth ==
Il faut d'abord installer blueZ:
<pre>
# apt-get install -y bluez bluez-tools
</pre>

Iot speaker

2019-07-16T17:24:26Z

Tala : /* Utilisation */

=Projet=
{|class="wikitable" width="100%"
|-valign=top
! Objectif !! Les acteurs !! Compétences !! Matériel
|-valign=top
||
Construire des enceintes sans-fils (sauf le courant) actives connectées capables de travailler en "groupe"
||
*[[User:Tala | Tala]]
*[[User:Nigdor |Nigdor]]
*[[User:Prandar |Prandar]]
||
*électronique
*C++ (microcontrôleur)
||
* microcontrôleur (esp8266)
* amplificateur audio (XPT8871, PAM8403, ...)
* décodeur MP3 (VS1053B)
* potentiomètre digital (X9C103S)
|}

= Choix de l'amplificateur =
A faire:
*Expliquer la différence entre classe AB et D (qualité sonore vs. éco énergie)
*Faire un tableau récapitulatif des caractéristiques des amplis:
** mono / stéréo / les deux
** tension de fonctionnement / consommation (5v, 12v, 24v, etc...)
** puissance (5w, 20w, 30w, etc...)
** impédance de sortie (2 x 4Ω, 1 x 8Ω, etc...)
** réponse fréquentielle ;
** résistance aux courts-circuits ;
** bruit pop (quand pas de musique);
** besoin d'un dissipateur ou non (effet joule à prévoir...)
** lien vers la documentation si besoin d'info(eg. pour le [https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932])
** le plus important : le ressenti !
==Classe AB==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
TDA7297
|align=center|
[[Fichier:TDA7297.png|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 15W
|align=center|
2A (peak)
|align=center|
6 - 18 V
|align=center|
OUI
|align=center|
Avec µControlleur<br>(p. 3/4)
|align=center|
Obligatoire
|align=center|
[http://www.st.com/content/ccc/resource/technical/document/datasheet/a3/eb/9b/59/dd/26/4a/27/CD00001048.pdf/files/CD00001048.pdf/jcr:content/translations/en.CD00001048.pdf TDA7297]
|align=left|
Super amplification sans distorsion !
<br>
Forte dissipation thermique à pleine puissance :
* 33W d'après la doc;
* vraiment très (trop) fort !
|}
</div>

==Classe D==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
XH-M531 (YDA138)
|align=center|
[[Fichier:XH-M531.jpg|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 10 W<br>
2 x 20 W
|align=center|
8 Ω<br>
4 Ω
|align=center|
12 - 15V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.ksp-electronics.com/product_files/8eeedc66ea8fbcdf2e74294037c2f389 YDA138]
|align=center|
|-valign="top"
|align=center|
PAM8403
|align=center|
[[Fichier:PAM8403.jpg|centré|100px]]
|align=center|
Stéréo
|align=center|
3W(*2 ?)
|align=center|
4 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
Reduit mais présent
|align=center|
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8403.pdf PAM8403]
|align=center|
|-valign="top"
|align=center|
PAM8610
|align=center|
[[Fichier:PAM8610.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 10 W
|align=center|
8 Ω
|align=center|
7 - 15 V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8610.pdf PAM8610]
|align=center|
|-valign="top"
|align=center|
XPT8871
|align=center|
[[Fichier:XPT8871.jpg|centré|120px]]
|align=center|
Mono
|align=center|
3.5w
<br>
5w
|align=center|
3 Ω
<br>
2 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[[Media:XPT8871.pdf|XPT8871]]
|align=left|
*Bien pour la voix, pas top pour la musique
|-valign="top"
|align=center|
TDA8932
|align=center|
[[Fichier:TDA8932.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2*15W
|align=center|
4 Ω
|align=center|
Entre 10 V et 36 V (Rechercher quel est le plus optimal)
|align=center|
OUI
|align=center|
NON
|align=center|

|align=center|
[https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932]
|align=center|
|-valign="top"
|align=center|
TPA3110
|align=center|
[[Fichier:TPA3110.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
15W/ch
|align=center|
8 Ω
|align=center|
16 V
|align=center|
OUI
|align=center|
NON
|align=center|
OUI
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3110d2.pdf TPA3110]
|align=left|
*Amplification moyenne
*Basses creuses
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3116
|align=center|
[[Fichier:TPA3116.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 50W<br>
2 x 15W
|align=center|
4 Ω<br>
8 Ω
|align=center|
21 V<br>
15 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI<br>
NON
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3116d2.pdf TPA3116]
|align=left|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3118
|align=center|
[[Fichier:TPA3118.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 30W
|align=center|
8 Ω
|align=center|
12 - 24 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI
|align=left|
[http://www.ti.com/lit/ds/symlink/tpa3118d2.pdf TPA3118]
|align=center|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|}
</div>

= Potentiomètre digital =
A faire

= Décodeur MP3 =
==Présentation==
Le décodeur MP3 choisi est le VS1053

[[Fichier:vs1053_board.jpg|centré|200px]]

Ce décodeur offre une interface SPI et permet de lire ainsi que d'enregistrer des fichiers aux formats :
* lecture :
**MP3 ;
**Ogg Vorbis (libre de droit) ;
**PCM;
**WAV;
* enregistrement :
**Ogg Vorbis(libre de droit) ;

==Documentation technique==
Voici la [[:Media:vs1053_doc.pdf|documentation du VS1053]], pour ceux qui voudraient écrire une librairie C++ !

== Schéma ==
Les tests ont été réalisés avec un WemOS D1 mini (ESP8266) :
<div align="center">
{|class="wikitable" width="85%"
! ESP8266 !! VS1053 !! Connections
|-valign=top
||
[[Fichier:wemos_D1_R2_mini_diagram.png|centré|470px]]
||
[[Fichier:vs1053_board_diagram.png|centré|300px]]
|align="center"|
{|class="wikitable"
! ESP8266 !! VS1053
|-
|align="center"| D0
|align="center"| XDCS
|-
|align="center"| D1
|align="center"| XoS (Cable Select)
|-
|align="center"| D3
|align="center"| DREQ
|-
|align="center"| D5
|align="center"| SCK (Serial ClocK)
|-
|align="center"| D6
|align="center"| MISO (Master In Slave Out)
|-
|align="center"| D7
|align="center"| MOSI (Master Out Slave In)
|-
|align="center"| RST
|align="center"| XRST
|-
|align="center"| 5V
|align="center"| 5V
|-
|align="center"| G
|align="center"| DGND
|}
|}
</div>
Vous devriez avoir quelque chose comme ça :

[[Fichier:wemos_D1_vs1053_diagram.jpg|centré|400px]]

== Programmation ==
Tout d'abord un grand merci à [https://github.com/baldram/ESP_VS1053_Library ''baldram''] pour sa [[Media:ESP_VS1053_Library.zip|librairie]] que nous allons utiliser !

Le plus simple est de regarder l'exemple ''SimpleMP3Player'' fourni avec la librairie :
<source lang="c">
// La fameuse librairie de baldram
#include <VS1053.h>
// Un MP3 au format binaire dans un tableau (le fichier est livré avec la librairie)
#include <helloMp3.h>
// Définition des port SPI utilisé (ici pour l'ESP8266)
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
// Définition du volume
#define VOLUME 80 // volume level 0-100
// Création de l'objet VS1053
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);

void setup () {
// Démarrage du SPI
SPI.begin();
// démarrage du VS1053
player.begin();
// Ligne nécessaire pour certain lecteur
player.switchToMp3Mode();
player.setVolume(VOLUME);
}

void loop() {
// On joue le MP3 dans le tableau
player.playChunk(helloMp3, sizeof(helloMp3));
// On attend 3 secondes
delay(3000);
}
</source>
Pour que cet exemple fonctionne, il faut soit copier le contenu de ''HelloMp3.h'' dans le fichier exemple, soit copier le fichier dans le répertoire de la librairie dans votre dossier ''Arduino''.

Une fois la compilation terminée, vous devriez entendre ''du bruit'' sortir du VS1053 !

= Flux musical =
La communication se fera en générant un flux entre le programme (PC) et l'enceinte (ESP8266). Ce flux, pour des raisons de simplicité, se fera en TCP car ce protocole gère les retransmissions, les tampons d'entrée / sortie, etc...

A terme, une application temps réel comme la musique mériterait de passer sur de l'UDP. Surtout que, si l'on souhaite utiliser du [https://www.tala-informatique.fr/wiki/index.php/Esp8266_udp_server multicast], pour parler à un groupe d'enceintes, on ne peut le faire qu'en UDP !
== Envoi : serveur en PHP ==
La partie serveur prend un fichier, ici un MP3, lit un morceau du fichier et l'envoi à l'enceinte à travers une socket TCP. Deux paramètres sont à prendre en compte :
*le temps d'attente entre chaque envoi;
*la taille d'un morceau;
Ces paramètres nécessiteront certainement un temps d'ajustement qui sera en fonction de la latence, la congestion du réseau, les capacités des puces impliquées (ici l'ESP8266), etc...
{|style="width:650px" align="center"
|
[[Fichier:warning-icon.png|centré|60px]]
|valign="top" align="justify"|
Les extraits de code qui vont suivre respectent vaguement les préceptes, au combien importants, de la programmation orientée objet et sont fournis à titre indicatif dans l'unique but de démontrer la faisabilité d'un tel projet ! Voici [[:Media:Iot_Speaker.zip | l'archive]] qui contient le code exposé ci-dessous.
|}
=== MusicSender ===
Voici le contenu du fichier ''MusicSender.class.php'' :
<source lang="php">
<?php

class MusicSender
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5045;

// Le temps d'attente en microsecondes entre chaque paquets
private static $SLEEP_INTERVAL = 2500;

// La taille de chacun des paquets
private static $CHUNK_BUFFER = 32768;

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Envoie le MP3 à l'enceinte
*
* @param string $mp3File
* @return boolean
*/
public function play($mp3File)
{
if (is_file($mp3File)) {
// Ouverture du fichier en lecture binaire
$file = fopen($mp3File, 'rb');
if ($file === FALSE) {
echo "Fail reading file " . $file . "\n";
return FALSE;
}
// Ouverture de la socket
$socket = $this->openSocket();
// Tant qu'on est pas à la fin du fichier
while (! feof($file)) {
// Envoie d'un "morceau" de taille CHUNK_BUFFER à l'enceinte
if (@socket_write($this->socket, fread($file, self::$CHUNK_BUFFER), self::$CHUNK_BUFFER) === FALSE) {
// Problème de socket (fermeture, déconnexion, etc...)
return FALSE;
}
usleep(self::$SLEEP_INTERVAL);
}
// Fermeture de la socket
$this->closeSocket();
// Fermeture du fichier
fclose($file);
return TRUE;
}
echo $file." does not exists !\n";
return FALSE;
}

/**
* Lit tous les mp3 présents dans le dossier
*
* @param string $dir
*/
public function readFolder($dir)
{
if (is_dir($dir)) {
// On récupére les fichiers sans les 2 premiers '.' et '..'
$files = array_slice(scandir($dir), 2);
foreach ($files as $file) {
// On créé le chemin absolu
$mp3File = $dir . DIRECTORY_SEPARATOR . $file;
// On test l'extension
if (pathinfo($file)["extension"] == "mp3") {
$this->play($mp3File);
}
}
return true;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) == FALSE) {
echo "socket_create_listen() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
if (socket_connect($this->socket, $this->ip, self::$PORT) == FALSE) {
echo "socket_bind() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
=== Launch.php ===
On créé un fichier ''Launch.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicSender.class.php';

$esp_ip = "192.168.1.200";

$dir = "!!chemin_vers_des_fichiers_mp3!!";

$sender = new MusicSender($esp_ip);

$sender->readFolder($dir);
</source>

== Réception : ESP8266 ==
{|style="width:650px" align="center"
|
[[Fichier:Warning manual.jpg|centré|300px]]
|valign="top" align="justify"|
Soyez sûr de comprendre la section sur [https://www.tala-informatique.fr/wiki/index.php/Arduino_sketch_writing| comment écrire un sketch] avant de poursuivre. Le code ci-dessous fait référence à des parties bien spécifiques, détaillées et expliquées dans la section suscitée.
|}
=== Partie WiFi ===
La première étape consiste à raccorder notre ''ESP'' au réseau WiFi !
<source lang="c">
#include <ESP8266WiFi.h>
#include <WiFiClient.h>

// WiFi Parameters //
const char ssid[] = "cfcasa";
const char password[] = "***********";
IPAddress ip(192, 168, 1, 200);
IPAddress gw(192, 168, 1, 254);
IPAddress mask(255, 255, 252, 0);

void setup() {
// on démarre le port série
Serial.begin(115200);
// On attend "un peu" que le buffer soit prêt
delay(10);
// On démarre le WiFi
initWiFi();
}

void loop() {
}

void initWiFi() {
// On efface la configuration précédente
WiFi.disconnect(true);
Serial.printf("\nConnexion a %s", ssid);
// Initialisation de la connection
WiFi.config(ip, gw, mask, gw);
WiFi.begin(ssid, password);
// Test pour déterminer quand la connection est prete
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(".");
}
// Affichage des informations
Serial.printf(" connecté\nAdresse IP: %s\n", WiFi.localIP().toString().c_str());
}
</source>
=== Lecteur MP3 ===
Vient ensuite la partie du lecteur MP3. Dans la partie des imports, ajoutez la ligne suivante :
<source lang="c">
#include <VS1053.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Parameters //
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
#define VOLUME 70 // volume level 0-100
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);
uint8_t volume_level = VOLUME;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le shield MP3
initMP3();
</source>
A la suite, on insère la fonction suivante :
<source lang="c">
void initMP3() {
SPI.begin();
// Démarrage du lecteur MP3
player.begin();
player.switchToMp3Mode();
player.setVolume(volume_level);
}
</source>
=== Récupération du stream MP3 ===
On va maintenant récupérer le flux envoyé depuis le serveur. Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Server parameters //
const uint16_t MP3_PORT = 5045;
WiFiServer server(MP3_PORT);
const uint16_t BUFFER_SIZE = 16384;
//const uint16_t BUFFER_SIZE = 32768;
byte buffer[BUFFER_SIZE + 1];
uint16_t byteRead = 0;
bool isBufferReady = false;
WiFiClient client;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur TCP
initMp3Server();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
void initMp3Server() {
// Démarrage du serveur TCP
server.begin();
Serial.printf("Ecoute TCP sur le port %d\n", MP3_PORT);
}

void readMp3() {
// Un client est connecté
if (client) {
// Si le client est toujours connecté...
if (client.connected()) {
// Tant que l'on reçoit de la musique
while (client.available() > 0) {
// On rempli le buffer avec le contenu du paquet TCP
buffer[byteRead++] = client.read();
// Si le buffer est plein
if (byteRead == BUFFER_SIZE) {
// On previent que le buffer est plein
isBufferReady = true;
// On sort de la boucle
break;
}
}
// Si le buffer est plein
if (isBufferReady) {
// On envoi tout au lecteur MP3
player.playChunk(buffer, byteRead);
// On RAZ le compteur de bytes
byteRead = 0;
}
} else {
// Si le client est déconneté
client = server.available();
// On prévient que le buffer est vide
isBufferReady = false;
// On RAZ le compteur de bytes
byteRead = 0;
Serial.println(F("Client disconnected"));
}
} else {
// On test la présence d'un client
client = server.available();
if (client) {
// Un client est connecté !
Serial.println(F("New client !"));
}
}
}
</source>
Enfin, on ajoute le ligne suivante dans la fonction ''loop()'' :
<source lang="c">
readMp3();
</source>
A ce stade, l'ESP devrait être capable de récupérer le flux et de le jouer !

= Envoi de commandes =
Envoyer de la musique c'est bien, pouvoir régler le volume c'est encore mieux !

La façon la plus simple d'adresser le problème c'est d'utiliser un autre port et, comme les messages sont petits, d'utiliser UDP.
== Partie Serveur ==
Dans la même veine, voici la classe qui permet d'envoyer les commandes :
<source lang="php">
<?php

class MusicHandler
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5046;

// Le port de l'enceinte connectée
private static $RETRIES = 3;

// Liste de commandes
private static $CMD_VOLUME = 'V';

private static $CMD_LOCATE = 'L';

private static $CMD_RESET = 'R';

private static $RESPONSE_NOK = 'N';

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Augmente le volume d'un incrément
*
* @return boolean
*/
public function volumeUp()
{
return $this->sendCommand(self::$CMD_VOLUME . "+");
}

/**
* Baisse le volume d'un incrément
*
* @return boolean
*/
public function volumeDown()
{
return $this->sendCommand(self::$CMD_VOLUME . "-");
}

/**
*
* @return boolean
*/
public function setVolume($volume)
{
if ($volume < 0 || $volume > 100) {
return false;
}
return $this->sendCommand(self::$CMD_VOLUME . $volume);
}

public function getVolume(){
return $this->sendCommand(self::$CMD_VOLUME);
}

/**
*
* @return boolean
*/
public function doReset()
{
return $this->sendCommand(self::$CMD_RESET);
}

public function doLocate(){
return $this->sendCommand(self::$CMD_LOCATE);
}

/**
* Envoie une commande au module
*
* @param string $message
*/
private function sendCommand($message)
{
$result = false;
if ($this->openSocket() !== FALSE) {
if (socket_sendto($this->socket, $message, strlen($message), 0, $this->ip, self::$PORT) !== FALSE) {
$result = $this->readAcknoledge();
}
}
$this->closeSocket();
return $result;
}

/**
* Attend la confirmation de la commande
*
* @return boolean
*/
private function readAcknoledge()
{
$buf = "";
$retries = 0;
while ($retries < self::$RETRIES) {
$byteReceived = socket_recvfrom($this->socket, $buf, 2048, 0, $this->ip, self::$PORT);
if ($byteReceived > 0) {
return $buf != self::$RESPONSE_NOK ? $buf : FALSE;
}
usleep(500000);
$retries ++;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) === FALSE) {
$errorcode = socket_last_error();
$errormsg = socket_strerror($errorcode);
echo ("Couldn't create socket: [$errorcode] $errormsg \n");
return false;
}
return true;
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
On créé un fichier ''Command.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicHandler.class.php';

$esp_ip = "192.168.1.200";

$handler = new MusicHandler($esp_ip);

// Exemple de commandes //
//$result = $handler->volumeUp();
//$result = $handler->getVolume();
//$result = $handler->doReset();
//$result = $handler->setVolume(70);

$result = $handler->doLocate();

echo $result !== FALSE ? "ok : $result\n" : "nok\n";
</source>
== Partie Cliente ==
Dans la partie des imports ajoutez la ligne suivante :
<source lang="c">
#include <WiFiUDP.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// Command Server parameters //
const uint16_t CMD_PORT = 5046;
// L'instance du serveur UDP
WiFiUDP udp;
// Liste de commandes
const char CMD_VOLUME = 'V';
const char CMD_LOCATE = 'L';
const char CMD_RESET = 'R';
const char RESPONSE_NOK[] = "N";

// Localisation parameters
uint8_t ledPin = LED_BUILTIN;
const uint16_t BLINK_FREQ = 500;
const uint8_t BLINK_REP = 60;
uint8_t repetition = 0;
uint32_t timer;
bool isLocate = false;
</source>
A la fin de la fonction setup() nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur UDP
initCmdServer();
// On prépare la led de localisation
initLocateLed();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
bool readCmd() {
if (udp.parsePacket() > 0) {
uint8_t len = udp.available();
char c = udp.read();
if (len == 1) {
if (c == CMD_RESET) {
player.softReset();
sendPacket(CMD_RESET);
return true;
} else if (c == CMD_VOLUME) {
sendPacket(volume_level);
return true;
} else if (c == CMD_LOCATE) {
if (!isLocate) {
locate(true);
sendPacket(CMD_LOCATE);
return true;
}
}
} else if (len == 2) {
char value = udp.read();
if (c == CMD_VOLUME) {
if (value == '+' && volume_level != 100) {
setVolume(volume_level + 1);
} else if (value == '-' && volume_level != 0) {
setVolume(volume_level - 1);
} else {
sendNack();
return false;
}
return true;
}
} else {
if (c == CMD_VOLUME) {
char value[4] = "0";
udp.read(value, 3);
uint8_t vol = atoi(value);
if (vol >= 0 && vol <= 100) {
setVolume(vol);
return true;
}
}
}
sendNack();
return false;
}
// Check if locate needs to be done
locate(false);
}
void locate(bool blink) {
if (blink) {
// Initialisation des variables
digitalWrite(ledPin, LOW);
isLocate = true;
repetition = 0;
timer = millis();
} else if (isLocate) {
// Calcule du temps
uint32_t elapsed = millis() - timer;
if (elapsed > BLINK_FREQ) {
repetition++;
if (repetition == BLINK_REP) {
// On a atteint le nombre de clignotements
isLocate = false;
digitalWrite(ledPin, HIGH);
} else {
// On fait clignoter la led
digitalWrite(ledPin, !digitalRead(ledPin));
timer = millis();
}
}
}
}

void setVolume(uint8_t vol) {
volume_level = vol;
Serial.printf("Setting volume to %d\n", volume_level);
player.setVolume(volume_level);
sendPacket(volume_level);
}

void sendNack() {
sendPacket(RESPONSE_NOK);
}

void sendPacket(const char content) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(const char content[]) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(int content) {
char value[4];
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(itoa(content, value, 10));
udp.endPacket();
}

void initCmdServer() {
// Démarrage du serveur TCP
udp.begin(CMD_PORT);
Serial.printf("Ecoute UDP sur le port %d\n", CMD_PORT);
}

void initLocateLed() {
pinMode(ledPin, OUTPUT);
digitalWrite(ledPin, HIGH);
}
</source>
L'ESP est maintenant capable de :
* monter / baisser le volume ;
* de faire un reset du lecteur MP3 (en cas de problème)
* de faire clignoter sa led pour être localisé facilement.

= Enceinte armbian =
Même objectif mais cette fois-ci avec Rygel, un lecteur DLNA.
==Installation ==
Le système:
<pre>
# apt-get update
</pre>
Le lecteur rygel:
<pre>
# apt-get -y install rygel-playbin
</pre>
Les différents plugins. Tout d'abord, récupérer les plugins en fonctions de la distribution:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | awk -F ' - ' '{print $1}')
# apt-get install ${plugins}
</pre>
Ensuite on procéde à l'installation:
<pre>
# apt-get install ${plugins}
</pre>
== Création du fichier de service ==
Il suffit de créer le fichier ''/etc/systemd/system/rygel.service'':
<pre>
[Unit]
Description=Rygel service
After=network-online.target

[Service]
Type=simple
UMask=007
ExecStart=/usr/bin/rygel -g 5
Restart=on-failure

# Configures the time to wait before service is stopped forcefully.
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
On peut lancer le service et l'activer au démarrage
<pre>
# systemctl start rygel
# systemctl enable rygel
</pre>
== Désactivation des logs ==
Comme l'enceinte n'est pas à proprement parler un serveur exécutant un service critique, on peut désactiver le système de logging pour économiser la durée de vie de la carte SD:
<pre>
# systemctl stop rsyslog
# systemctl disable rsyslog
</pre>
== Ajustement du volume ==
Il faut maintenant mettre le volume au maximum coté Pi avec le mixer ALSA [https://fr.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture wikipedia] :
<pre>
# alsamixer
</pre>
[[Fichier:alsamixer armbian.png|centré]]
== Changement de la carte son par défaut ==
Une fois la carte son USB installée, il suffit d'utiliser la commande suivante pour voir son identifiant:
<pre>
# aplay -l
**** List of PLAYBACK Hardware Devices ****
card 0: sun4icodec [sun4i-codec], device 0: CDC PCM Codec-0 []
Subdevices: 1/1
Subdevice #0: subdevice #0
card 1: Device [USB Audio Device], device 0: USB Audio [USB Audio]
Subdevices: 0/1
Subdevice #0: subdevice #0
</pre>
La carte son avec l'ID ''0'' est celle intégrée au PI, celle avec l'ID ''1'' est la carte USB.
Pour dire à ALSA que c'est la carte avec l'ID ''1'' que l'on veut par défaut, il suffit de créer le fichier ''/etc/asound.conf'' avec les lignes suivantes:
<pre>
defaults.pcm.card 1
defaults.ctl.card 1
</pre>
La configuration est appliquée après un redémarrage !

== WiringPI==
===Installation===
<pre>
# cd /opt
# git clone https://github.com/LeMaker/WiringLMK.git
# cd WiringLMK
# chmod +x ./build
# ./build
</pre>

=== Utilisation===
Pour la lecture des états
<pre>
# gpio readall
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| | | 3.3v | | | 1 || 2 | | | 5v | | |
| 2 | 8 | SDA.1 | ALT5 | 0 | 3 || 4 | | | 5V | | |
| 3 | 9 | SCL.1 | ALT5 | 0 | 5 || 6 | | | 0v | | |
| 4 | 7 | GPIO. 7 | IN | 0 | 7 || 8 | 1 | ALT2 | TxD | 15 | 14 |
| | | 0v | | | 9 || 10 | 0 | IN | RxD | 16 | 15 |
| 17 | 0 | GPIO. 0 | IN | 0 | 11 || 12 | 0 | IN | GPIO. 1 | 1 | 18 |
| 27 | 2 | GPIO. 2 | IN | 0 | 13 || 14 | | | 0v | | |
| 22 | 3 | GPIO. 3 | IN | 0 | 15 || 16 | 0 | IN | GPIO. 4 | 4 | 23 |
| | | 3.3v | | | 17 || 18 | 0 | IN | GPIO. 5 | 5 | 24 |
| 10 | 12 | MOSI | ALT5 | 0 | 19 || 20 | | | 0v | | |
| 9 | 13 | MISO | ALT5 | 0 | 21 || 22 | 0 | IN | GPIO. 6 | 6 | 25 |
| 11 | 14 | SCLK | ALT5 | 0 | 23 || 24 | 0 | ALT5 | CE0 | 10 | 8 |
| | | 0v | | | 25 || 26 | 0 | ALT5 | CE1 | 11 | 7 |
| 0 | 30 | SDA.0 | IN | 1 | 27 || 28 | 1 | IN | SCL.0 | 31 | 1 |
| 5 | 21 | GPIO.21 | IN | 0 | 29 || 30 | | | 0v | | |
| 6 | 22 | GPIO.22 | ALT4 | 0 | 31 || 32 | 0 | ALT4 | GPIO.26 | 26 | 12 |
| 13 | 23 | GPIO.23 | IN | 0 | 33 || 34 | | | 0v | | |
| 19 | 24 | GPIO.24 | IN | 0 | 35 || 36 | 0 | IN | GPIO.27 | 27 | 16 |
| 26 | 25 | GPIO.25 | IN | 0 | 37 || 38 | 0 | IN | GPIO.28 | 28 | 20 |
| | | 0v | | | 39 || 40 | 0 | IN | GPIO.29 | 29 | 21 |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
</pre>
Ou d'un état:
<pre>
# gpio read 1
0
</pre>
Changement d'état:
<pre>
# gpio -1 write 8 0
</pre>

== Ajout du bluetooth ==
Il faut d'abord installer blueZ:
<pre>
# apt-get install -y bluez bluez-tools
</pre>

Iot speaker

2019-07-16T17:24:11Z

Tala : /* Installation de WiringPI */

=Projet=
{|class="wikitable" width="100%"
|-valign=top
! Objectif !! Les acteurs !! Compétences !! Matériel
|-valign=top
||
Construire des enceintes sans-fils (sauf le courant) actives connectées capables de travailler en "groupe"
||
*[[User:Tala | Tala]]
*[[User:Nigdor |Nigdor]]
*[[User:Prandar |Prandar]]
||
*électronique
*C++ (microcontrôleur)
||
* microcontrôleur (esp8266)
* amplificateur audio (XPT8871, PAM8403, ...)
* décodeur MP3 (VS1053B)
* potentiomètre digital (X9C103S)
|}

= Choix de l'amplificateur =
A faire:
*Expliquer la différence entre classe AB et D (qualité sonore vs. éco énergie)
*Faire un tableau récapitulatif des caractéristiques des amplis:
** mono / stéréo / les deux
** tension de fonctionnement / consommation (5v, 12v, 24v, etc...)
** puissance (5w, 20w, 30w, etc...)
** impédance de sortie (2 x 4Ω, 1 x 8Ω, etc...)
** réponse fréquentielle ;
** résistance aux courts-circuits ;
** bruit pop (quand pas de musique);
** besoin d'un dissipateur ou non (effet joule à prévoir...)
** lien vers la documentation si besoin d'info(eg. pour le [https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932])
** le plus important : le ressenti !
==Classe AB==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
TDA7297
|align=center|
[[Fichier:TDA7297.png|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 15W
|align=center|
2A (peak)
|align=center|
6 - 18 V
|align=center|
OUI
|align=center|
Avec µControlleur<br>(p. 3/4)
|align=center|
Obligatoire
|align=center|
[http://www.st.com/content/ccc/resource/technical/document/datasheet/a3/eb/9b/59/dd/26/4a/27/CD00001048.pdf/files/CD00001048.pdf/jcr:content/translations/en.CD00001048.pdf TDA7297]
|align=left|
Super amplification sans distorsion !
<br>
Forte dissipation thermique à pleine puissance :
* 33W d'après la doc;
* vraiment très (trop) fort !
|}
</div>

==Classe D==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
XH-M531 (YDA138)
|align=center|
[[Fichier:XH-M531.jpg|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 10 W<br>
2 x 20 W
|align=center|
8 Ω<br>
4 Ω
|align=center|
12 - 15V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.ksp-electronics.com/product_files/8eeedc66ea8fbcdf2e74294037c2f389 YDA138]
|align=center|
|-valign="top"
|align=center|
PAM8403
|align=center|
[[Fichier:PAM8403.jpg|centré|100px]]
|align=center|
Stéréo
|align=center|
3W(*2 ?)
|align=center|
4 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
Reduit mais présent
|align=center|
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8403.pdf PAM8403]
|align=center|
|-valign="top"
|align=center|
PAM8610
|align=center|
[[Fichier:PAM8610.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 10 W
|align=center|
8 Ω
|align=center|
7 - 15 V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8610.pdf PAM8610]
|align=center|
|-valign="top"
|align=center|
XPT8871
|align=center|
[[Fichier:XPT8871.jpg|centré|120px]]
|align=center|
Mono
|align=center|
3.5w
<br>
5w
|align=center|
3 Ω
<br>
2 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[[Media:XPT8871.pdf|XPT8871]]
|align=left|
*Bien pour la voix, pas top pour la musique
|-valign="top"
|align=center|
TDA8932
|align=center|
[[Fichier:TDA8932.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2*15W
|align=center|
4 Ω
|align=center|
Entre 10 V et 36 V (Rechercher quel est le plus optimal)
|align=center|
OUI
|align=center|
NON
|align=center|

|align=center|
[https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932]
|align=center|
|-valign="top"
|align=center|
TPA3110
|align=center|
[[Fichier:TPA3110.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
15W/ch
|align=center|
8 Ω
|align=center|
16 V
|align=center|
OUI
|align=center|
NON
|align=center|
OUI
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3110d2.pdf TPA3110]
|align=left|
*Amplification moyenne
*Basses creuses
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3116
|align=center|
[[Fichier:TPA3116.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 50W<br>
2 x 15W
|align=center|
4 Ω<br>
8 Ω
|align=center|
21 V<br>
15 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI<br>
NON
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3116d2.pdf TPA3116]
|align=left|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3118
|align=center|
[[Fichier:TPA3118.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 30W
|align=center|
8 Ω
|align=center|
12 - 24 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI
|align=left|
[http://www.ti.com/lit/ds/symlink/tpa3118d2.pdf TPA3118]
|align=center|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|}
</div>

= Potentiomètre digital =
A faire

= Décodeur MP3 =
==Présentation==
Le décodeur MP3 choisi est le VS1053

[[Fichier:vs1053_board.jpg|centré|200px]]

Ce décodeur offre une interface SPI et permet de lire ainsi que d'enregistrer des fichiers aux formats :
* lecture :
**MP3 ;
**Ogg Vorbis (libre de droit) ;
**PCM;
**WAV;
* enregistrement :
**Ogg Vorbis(libre de droit) ;

==Documentation technique==
Voici la [[:Media:vs1053_doc.pdf|documentation du VS1053]], pour ceux qui voudraient écrire une librairie C++ !

== Schéma ==
Les tests ont été réalisés avec un WemOS D1 mini (ESP8266) :
<div align="center">
{|class="wikitable" width="85%"
! ESP8266 !! VS1053 !! Connections
|-valign=top
||
[[Fichier:wemos_D1_R2_mini_diagram.png|centré|470px]]
||
[[Fichier:vs1053_board_diagram.png|centré|300px]]
|align="center"|
{|class="wikitable"
! ESP8266 !! VS1053
|-
|align="center"| D0
|align="center"| XDCS
|-
|align="center"| D1
|align="center"| XoS (Cable Select)
|-
|align="center"| D3
|align="center"| DREQ
|-
|align="center"| D5
|align="center"| SCK (Serial ClocK)
|-
|align="center"| D6
|align="center"| MISO (Master In Slave Out)
|-
|align="center"| D7
|align="center"| MOSI (Master Out Slave In)
|-
|align="center"| RST
|align="center"| XRST
|-
|align="center"| 5V
|align="center"| 5V
|-
|align="center"| G
|align="center"| DGND
|}
|}
</div>
Vous devriez avoir quelque chose comme ça :

[[Fichier:wemos_D1_vs1053_diagram.jpg|centré|400px]]

== Programmation ==
Tout d'abord un grand merci à [https://github.com/baldram/ESP_VS1053_Library ''baldram''] pour sa [[Media:ESP_VS1053_Library.zip|librairie]] que nous allons utiliser !

Le plus simple est de regarder l'exemple ''SimpleMP3Player'' fourni avec la librairie :
<source lang="c">
// La fameuse librairie de baldram
#include <VS1053.h>
// Un MP3 au format binaire dans un tableau (le fichier est livré avec la librairie)
#include <helloMp3.h>
// Définition des port SPI utilisé (ici pour l'ESP8266)
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
// Définition du volume
#define VOLUME 80 // volume level 0-100
// Création de l'objet VS1053
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);

void setup () {
// Démarrage du SPI
SPI.begin();
// démarrage du VS1053
player.begin();
// Ligne nécessaire pour certain lecteur
player.switchToMp3Mode();
player.setVolume(VOLUME);
}

void loop() {
// On joue le MP3 dans le tableau
player.playChunk(helloMp3, sizeof(helloMp3));
// On attend 3 secondes
delay(3000);
}
</source>
Pour que cet exemple fonctionne, il faut soit copier le contenu de ''HelloMp3.h'' dans le fichier exemple, soit copier le fichier dans le répertoire de la librairie dans votre dossier ''Arduino''.

Une fois la compilation terminée, vous devriez entendre ''du bruit'' sortir du VS1053 !

= Flux musical =
La communication se fera en générant un flux entre le programme (PC) et l'enceinte (ESP8266). Ce flux, pour des raisons de simplicité, se fera en TCP car ce protocole gère les retransmissions, les tampons d'entrée / sortie, etc...

A terme, une application temps réel comme la musique mériterait de passer sur de l'UDP. Surtout que, si l'on souhaite utiliser du [https://www.tala-informatique.fr/wiki/index.php/Esp8266_udp_server multicast], pour parler à un groupe d'enceintes, on ne peut le faire qu'en UDP !
== Envoi : serveur en PHP ==
La partie serveur prend un fichier, ici un MP3, lit un morceau du fichier et l'envoi à l'enceinte à travers une socket TCP. Deux paramètres sont à prendre en compte :
*le temps d'attente entre chaque envoi;
*la taille d'un morceau;
Ces paramètres nécessiteront certainement un temps d'ajustement qui sera en fonction de la latence, la congestion du réseau, les capacités des puces impliquées (ici l'ESP8266), etc...
{|style="width:650px" align="center"
|
[[Fichier:warning-icon.png|centré|60px]]
|valign="top" align="justify"|
Les extraits de code qui vont suivre respectent vaguement les préceptes, au combien importants, de la programmation orientée objet et sont fournis à titre indicatif dans l'unique but de démontrer la faisabilité d'un tel projet ! Voici [[:Media:Iot_Speaker.zip | l'archive]] qui contient le code exposé ci-dessous.
|}
=== MusicSender ===
Voici le contenu du fichier ''MusicSender.class.php'' :
<source lang="php">
<?php

class MusicSender
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5045;

// Le temps d'attente en microsecondes entre chaque paquets
private static $SLEEP_INTERVAL = 2500;

// La taille de chacun des paquets
private static $CHUNK_BUFFER = 32768;

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Envoie le MP3 à l'enceinte
*
* @param string $mp3File
* @return boolean
*/
public function play($mp3File)
{
if (is_file($mp3File)) {
// Ouverture du fichier en lecture binaire
$file = fopen($mp3File, 'rb');
if ($file === FALSE) {
echo "Fail reading file " . $file . "\n";
return FALSE;
}
// Ouverture de la socket
$socket = $this->openSocket();
// Tant qu'on est pas à la fin du fichier
while (! feof($file)) {
// Envoie d'un "morceau" de taille CHUNK_BUFFER à l'enceinte
if (@socket_write($this->socket, fread($file, self::$CHUNK_BUFFER), self::$CHUNK_BUFFER) === FALSE) {
// Problème de socket (fermeture, déconnexion, etc...)
return FALSE;
}
usleep(self::$SLEEP_INTERVAL);
}
// Fermeture de la socket
$this->closeSocket();
// Fermeture du fichier
fclose($file);
return TRUE;
}
echo $file." does not exists !\n";
return FALSE;
}

/**
* Lit tous les mp3 présents dans le dossier
*
* @param string $dir
*/
public function readFolder($dir)
{
if (is_dir($dir)) {
// On récupére les fichiers sans les 2 premiers '.' et '..'
$files = array_slice(scandir($dir), 2);
foreach ($files as $file) {
// On créé le chemin absolu
$mp3File = $dir . DIRECTORY_SEPARATOR . $file;
// On test l'extension
if (pathinfo($file)["extension"] == "mp3") {
$this->play($mp3File);
}
}
return true;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) == FALSE) {
echo "socket_create_listen() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
if (socket_connect($this->socket, $this->ip, self::$PORT) == FALSE) {
echo "socket_bind() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
=== Launch.php ===
On créé un fichier ''Launch.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicSender.class.php';

$esp_ip = "192.168.1.200";

$dir = "!!chemin_vers_des_fichiers_mp3!!";

$sender = new MusicSender($esp_ip);

$sender->readFolder($dir);
</source>

== Réception : ESP8266 ==
{|style="width:650px" align="center"
|
[[Fichier:Warning manual.jpg|centré|300px]]
|valign="top" align="justify"|
Soyez sûr de comprendre la section sur [https://www.tala-informatique.fr/wiki/index.php/Arduino_sketch_writing| comment écrire un sketch] avant de poursuivre. Le code ci-dessous fait référence à des parties bien spécifiques, détaillées et expliquées dans la section suscitée.
|}
=== Partie WiFi ===
La première étape consiste à raccorder notre ''ESP'' au réseau WiFi !
<source lang="c">
#include <ESP8266WiFi.h>
#include <WiFiClient.h>

// WiFi Parameters //
const char ssid[] = "cfcasa";
const char password[] = "***********";
IPAddress ip(192, 168, 1, 200);
IPAddress gw(192, 168, 1, 254);
IPAddress mask(255, 255, 252, 0);

void setup() {
// on démarre le port série
Serial.begin(115200);
// On attend "un peu" que le buffer soit prêt
delay(10);
// On démarre le WiFi
initWiFi();
}

void loop() {
}

void initWiFi() {
// On efface la configuration précédente
WiFi.disconnect(true);
Serial.printf("\nConnexion a %s", ssid);
// Initialisation de la connection
WiFi.config(ip, gw, mask, gw);
WiFi.begin(ssid, password);
// Test pour déterminer quand la connection est prete
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(".");
}
// Affichage des informations
Serial.printf(" connecté\nAdresse IP: %s\n", WiFi.localIP().toString().c_str());
}
</source>
=== Lecteur MP3 ===
Vient ensuite la partie du lecteur MP3. Dans la partie des imports, ajoutez la ligne suivante :
<source lang="c">
#include <VS1053.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Parameters //
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
#define VOLUME 70 // volume level 0-100
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);
uint8_t volume_level = VOLUME;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le shield MP3
initMP3();
</source>
A la suite, on insère la fonction suivante :
<source lang="c">
void initMP3() {
SPI.begin();
// Démarrage du lecteur MP3
player.begin();
player.switchToMp3Mode();
player.setVolume(volume_level);
}
</source>
=== Récupération du stream MP3 ===
On va maintenant récupérer le flux envoyé depuis le serveur. Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Server parameters //
const uint16_t MP3_PORT = 5045;
WiFiServer server(MP3_PORT);
const uint16_t BUFFER_SIZE = 16384;
//const uint16_t BUFFER_SIZE = 32768;
byte buffer[BUFFER_SIZE + 1];
uint16_t byteRead = 0;
bool isBufferReady = false;
WiFiClient client;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur TCP
initMp3Server();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
void initMp3Server() {
// Démarrage du serveur TCP
server.begin();
Serial.printf("Ecoute TCP sur le port %d\n", MP3_PORT);
}

void readMp3() {
// Un client est connecté
if (client) {
// Si le client est toujours connecté...
if (client.connected()) {
// Tant que l'on reçoit de la musique
while (client.available() > 0) {
// On rempli le buffer avec le contenu du paquet TCP
buffer[byteRead++] = client.read();
// Si le buffer est plein
if (byteRead == BUFFER_SIZE) {
// On previent que le buffer est plein
isBufferReady = true;
// On sort de la boucle
break;
}
}
// Si le buffer est plein
if (isBufferReady) {
// On envoi tout au lecteur MP3
player.playChunk(buffer, byteRead);
// On RAZ le compteur de bytes
byteRead = 0;
}
} else {
// Si le client est déconneté
client = server.available();
// On prévient que le buffer est vide
isBufferReady = false;
// On RAZ le compteur de bytes
byteRead = 0;
Serial.println(F("Client disconnected"));
}
} else {
// On test la présence d'un client
client = server.available();
if (client) {
// Un client est connecté !
Serial.println(F("New client !"));
}
}
}
</source>
Enfin, on ajoute le ligne suivante dans la fonction ''loop()'' :
<source lang="c">
readMp3();
</source>
A ce stade, l'ESP devrait être capable de récupérer le flux et de le jouer !

= Envoi de commandes =
Envoyer de la musique c'est bien, pouvoir régler le volume c'est encore mieux !

La façon la plus simple d'adresser le problème c'est d'utiliser un autre port et, comme les messages sont petits, d'utiliser UDP.
== Partie Serveur ==
Dans la même veine, voici la classe qui permet d'envoyer les commandes :
<source lang="php">
<?php

class MusicHandler
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5046;

// Le port de l'enceinte connectée
private static $RETRIES = 3;

// Liste de commandes
private static $CMD_VOLUME = 'V';

private static $CMD_LOCATE = 'L';

private static $CMD_RESET = 'R';

private static $RESPONSE_NOK = 'N';

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Augmente le volume d'un incrément
*
* @return boolean
*/
public function volumeUp()
{
return $this->sendCommand(self::$CMD_VOLUME . "+");
}

/**
* Baisse le volume d'un incrément
*
* @return boolean
*/
public function volumeDown()
{
return $this->sendCommand(self::$CMD_VOLUME . "-");
}

/**
*
* @return boolean
*/
public function setVolume($volume)
{
if ($volume < 0 || $volume > 100) {
return false;
}
return $this->sendCommand(self::$CMD_VOLUME . $volume);
}

public function getVolume(){
return $this->sendCommand(self::$CMD_VOLUME);
}

/**
*
* @return boolean
*/
public function doReset()
{
return $this->sendCommand(self::$CMD_RESET);
}

public function doLocate(){
return $this->sendCommand(self::$CMD_LOCATE);
}

/**
* Envoie une commande au module
*
* @param string $message
*/
private function sendCommand($message)
{
$result = false;
if ($this->openSocket() !== FALSE) {
if (socket_sendto($this->socket, $message, strlen($message), 0, $this->ip, self::$PORT) !== FALSE) {
$result = $this->readAcknoledge();
}
}
$this->closeSocket();
return $result;
}

/**
* Attend la confirmation de la commande
*
* @return boolean
*/
private function readAcknoledge()
{
$buf = "";
$retries = 0;
while ($retries < self::$RETRIES) {
$byteReceived = socket_recvfrom($this->socket, $buf, 2048, 0, $this->ip, self::$PORT);
if ($byteReceived > 0) {
return $buf != self::$RESPONSE_NOK ? $buf : FALSE;
}
usleep(500000);
$retries ++;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) === FALSE) {
$errorcode = socket_last_error();
$errormsg = socket_strerror($errorcode);
echo ("Couldn't create socket: [$errorcode] $errormsg \n");
return false;
}
return true;
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
On créé un fichier ''Command.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicHandler.class.php';

$esp_ip = "192.168.1.200";

$handler = new MusicHandler($esp_ip);

// Exemple de commandes //
//$result = $handler->volumeUp();
//$result = $handler->getVolume();
//$result = $handler->doReset();
//$result = $handler->setVolume(70);

$result = $handler->doLocate();

echo $result !== FALSE ? "ok : $result\n" : "nok\n";
</source>
== Partie Cliente ==
Dans la partie des imports ajoutez la ligne suivante :
<source lang="c">
#include <WiFiUDP.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// Command Server parameters //
const uint16_t CMD_PORT = 5046;
// L'instance du serveur UDP
WiFiUDP udp;
// Liste de commandes
const char CMD_VOLUME = 'V';
const char CMD_LOCATE = 'L';
const char CMD_RESET = 'R';
const char RESPONSE_NOK[] = "N";

// Localisation parameters
uint8_t ledPin = LED_BUILTIN;
const uint16_t BLINK_FREQ = 500;
const uint8_t BLINK_REP = 60;
uint8_t repetition = 0;
uint32_t timer;
bool isLocate = false;
</source>
A la fin de la fonction setup() nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur UDP
initCmdServer();
// On prépare la led de localisation
initLocateLed();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
bool readCmd() {
if (udp.parsePacket() > 0) {
uint8_t len = udp.available();
char c = udp.read();
if (len == 1) {
if (c == CMD_RESET) {
player.softReset();
sendPacket(CMD_RESET);
return true;
} else if (c == CMD_VOLUME) {
sendPacket(volume_level);
return true;
} else if (c == CMD_LOCATE) {
if (!isLocate) {
locate(true);
sendPacket(CMD_LOCATE);
return true;
}
}
} else if (len == 2) {
char value = udp.read();
if (c == CMD_VOLUME) {
if (value == '+' && volume_level != 100) {
setVolume(volume_level + 1);
} else if (value == '-' && volume_level != 0) {
setVolume(volume_level - 1);
} else {
sendNack();
return false;
}
return true;
}
} else {
if (c == CMD_VOLUME) {
char value[4] = "0";
udp.read(value, 3);
uint8_t vol = atoi(value);
if (vol >= 0 && vol <= 100) {
setVolume(vol);
return true;
}
}
}
sendNack();
return false;
}
// Check if locate needs to be done
locate(false);
}
void locate(bool blink) {
if (blink) {
// Initialisation des variables
digitalWrite(ledPin, LOW);
isLocate = true;
repetition = 0;
timer = millis();
} else if (isLocate) {
// Calcule du temps
uint32_t elapsed = millis() - timer;
if (elapsed > BLINK_FREQ) {
repetition++;
if (repetition == BLINK_REP) {
// On a atteint le nombre de clignotements
isLocate = false;
digitalWrite(ledPin, HIGH);
} else {
// On fait clignoter la led
digitalWrite(ledPin, !digitalRead(ledPin));
timer = millis();
}
}
}
}

void setVolume(uint8_t vol) {
volume_level = vol;
Serial.printf("Setting volume to %d\n", volume_level);
player.setVolume(volume_level);
sendPacket(volume_level);
}

void sendNack() {
sendPacket(RESPONSE_NOK);
}

void sendPacket(const char content) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(const char content[]) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(int content) {
char value[4];
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(itoa(content, value, 10));
udp.endPacket();
}

void initCmdServer() {
// Démarrage du serveur TCP
udp.begin(CMD_PORT);
Serial.printf("Ecoute UDP sur le port %d\n", CMD_PORT);
}

void initLocateLed() {
pinMode(ledPin, OUTPUT);
digitalWrite(ledPin, HIGH);
}
</source>
L'ESP est maintenant capable de :
* monter / baisser le volume ;
* de faire un reset du lecteur MP3 (en cas de problème)
* de faire clignoter sa led pour être localisé facilement.

= Enceinte armbian =
Même objectif mais cette fois-ci avec Rygel, un lecteur DLNA.
==Installation ==
Le système:
<pre>
# apt-get update
</pre>
Le lecteur rygel:
<pre>
# apt-get -y install rygel-playbin
</pre>
Les différents plugins. Tout d'abord, récupérer les plugins en fonctions de la distribution:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | awk -F ' - ' '{print $1}')
# apt-get install ${plugins}
</pre>
Ensuite on procéde à l'installation:
<pre>
# apt-get install ${plugins}
</pre>
== Création du fichier de service ==
Il suffit de créer le fichier ''/etc/systemd/system/rygel.service'':
<pre>
[Unit]
Description=Rygel service
After=network-online.target

[Service]
Type=simple
UMask=007
ExecStart=/usr/bin/rygel -g 5
Restart=on-failure

# Configures the time to wait before service is stopped forcefully.
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
On peut lancer le service et l'activer au démarrage
<pre>
# systemctl start rygel
# systemctl enable rygel
</pre>
== Désactivation des logs ==
Comme l'enceinte n'est pas à proprement parler un serveur exécutant un service critique, on peut désactiver le système de logging pour économiser la durée de vie de la carte SD:
<pre>
# systemctl stop rsyslog
# systemctl disable rsyslog
</pre>
== Ajustement du volume ==
Il faut maintenant mettre le volume au maximum coté Pi avec le mixer ALSA [https://fr.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture wikipedia] :
<pre>
# alsamixer
</pre>
[[Fichier:alsamixer armbian.png|centré]]
== Changement de la carte son par défaut ==
Une fois la carte son USB installée, il suffit d'utiliser la commande suivante pour voir son identifiant:
<pre>
# aplay -l
**** List of PLAYBACK Hardware Devices ****
card 0: sun4icodec [sun4i-codec], device 0: CDC PCM Codec-0 []
Subdevices: 1/1
Subdevice #0: subdevice #0
card 1: Device [USB Audio Device], device 0: USB Audio [USB Audio]
Subdevices: 0/1
Subdevice #0: subdevice #0
</pre>
La carte son avec l'ID ''0'' est celle intégrée au PI, celle avec l'ID ''1'' est la carte USB.
Pour dire à ALSA que c'est la carte avec l'ID ''1'' que l'on veut par défaut, il suffit de créer le fichier ''/etc/asound.conf'' avec les lignes suivantes:
<pre>
defaults.pcm.card 1
defaults.ctl.card 1
</pre>
La configuration est appliquée après un redémarrage !

== WiringPI==
===Installation===
<pre>
# cd /opt
# git clone https://github.com/LeMaker/WiringLMK.git
# cd WiringLMK
# chmod +x ./build
# ./build
</pre>

=== Utilisation===
Pour la lecture des états
<pre>
# gpio readall
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| | | 3.3v | | | 1 || 2 | | | 5v | | |
| 2 | 8 | SDA.1 | ALT5 | 0 | 3 || 4 | | | 5V | | |
| 3 | 9 | SCL.1 | ALT5 | 0 | 5 || 6 | | | 0v | | |
| 4 | 7 | GPIO. 7 | IN | 0 | 7 || 8 | 1 | ALT2 | TxD | 15 | 14 |
| | | 0v | | | 9 || 10 | 0 | IN | RxD | 16 | 15 |
| 17 | 0 | GPIO. 0 | IN | 0 | 11 || 12 | 0 | IN | GPIO. 1 | 1 | 18 |
| 27 | 2 | GPIO. 2 | IN | 0 | 13 || 14 | | | 0v | | |
| 22 | 3 | GPIO. 3 | IN | 0 | 15 || 16 | 0 | IN | GPIO. 4 | 4 | 23 |
| | | 3.3v | | | 17 || 18 | 0 | IN | GPIO. 5 | 5 | 24 |
| 10 | 12 | MOSI | ALT5 | 0 | 19 || 20 | | | 0v | | |
| 9 | 13 | MISO | ALT5 | 0 | 21 || 22 | 0 | IN | GPIO. 6 | 6 | 25 |
| 11 | 14 | SCLK | ALT5 | 0 | 23 || 24 | 0 | ALT5 | CE0 | 10 | 8 |
| | | 0v | | | 25 || 26 | 0 | ALT5 | CE1 | 11 | 7 |
| 0 | 30 | SDA.0 | IN | 1 | 27 || 28 | 1 | IN | SCL.0 | 31 | 1 |
| 5 | 21 | GPIO.21 | IN | 0 | 29 || 30 | | | 0v | | |
| 6 | 22 | GPIO.22 | ALT4 | 0 | 31 || 32 | 0 | ALT4 | GPIO.26 | 26 | 12 |
| 13 | 23 | GPIO.23 | IN | 0 | 33 || 34 | | | 0v | | |
| 19 | 24 | GPIO.24 | IN | 0 | 35 || 36 | 0 | IN | GPIO.27 | 27 | 16 |
| 26 | 25 | GPIO.25 | IN | 0 | 37 || 38 | 0 | IN | GPIO.28 | 28 | 20 |
| | | 0v | | | 39 || 40 | 0 | IN | GPIO.29 | 29 | 21 |
+-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
| BCM | wPi | Name | Mode | V | Physical | V | Mode | Name | wPi | BCM |
+-----+-----+---------+------+---+--Banana Pro--+---+------+---------+-----+-----+
</pre>
Ou d'un état:
<pre>
# gpio read 1
0
</pre>
Changement d'état:
<pre>
gpio -1 write 8 0
</pre>

== Ajout du bluetooth ==
Il faut d'abord installer blueZ:
<pre>
# apt-get install -y bluez bluez-tools
</pre>

Iot speaker

2019-07-16T16:48:17Z

Tala : /* Changement de la carte son par défaut */

=Projet=
{|class="wikitable" width="100%"
|-valign=top
! Objectif !! Les acteurs !! Compétences !! Matériel
|-valign=top
||
Construire des enceintes sans-fils (sauf le courant) actives connectées capables de travailler en "groupe"
||
*[[User:Tala | Tala]]
*[[User:Nigdor |Nigdor]]
*[[User:Prandar |Prandar]]
||
*électronique
*C++ (microcontrôleur)
||
* microcontrôleur (esp8266)
* amplificateur audio (XPT8871, PAM8403, ...)
* décodeur MP3 (VS1053B)
* potentiomètre digital (X9C103S)
|}

= Choix de l'amplificateur =
A faire:
*Expliquer la différence entre classe AB et D (qualité sonore vs. éco énergie)
*Faire un tableau récapitulatif des caractéristiques des amplis:
** mono / stéréo / les deux
** tension de fonctionnement / consommation (5v, 12v, 24v, etc...)
** puissance (5w, 20w, 30w, etc...)
** impédance de sortie (2 x 4Ω, 1 x 8Ω, etc...)
** réponse fréquentielle ;
** résistance aux courts-circuits ;
** bruit pop (quand pas de musique);
** besoin d'un dissipateur ou non (effet joule à prévoir...)
** lien vers la documentation si besoin d'info(eg. pour le [https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932])
** le plus important : le ressenti !
==Classe AB==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
TDA7297
|align=center|
[[Fichier:TDA7297.png|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 15W
|align=center|
2A (peak)
|align=center|
6 - 18 V
|align=center|
OUI
|align=center|
Avec µControlleur<br>(p. 3/4)
|align=center|
Obligatoire
|align=center|
[http://www.st.com/content/ccc/resource/technical/document/datasheet/a3/eb/9b/59/dd/26/4a/27/CD00001048.pdf/files/CD00001048.pdf/jcr:content/translations/en.CD00001048.pdf TDA7297]
|align=left|
Super amplification sans distorsion !
<br>
Forte dissipation thermique à pleine puissance :
* 33W d'après la doc;
* vraiment très (trop) fort !
|}
</div>

==Classe D==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
XH-M531 (YDA138)
|align=center|
[[Fichier:XH-M531.jpg|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 10 W<br>
2 x 20 W
|align=center|
8 Ω<br>
4 Ω
|align=center|
12 - 15V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.ksp-electronics.com/product_files/8eeedc66ea8fbcdf2e74294037c2f389 YDA138]
|align=center|
|-valign="top"
|align=center|
PAM8403
|align=center|
[[Fichier:PAM8403.jpg|centré|100px]]
|align=center|
Stéréo
|align=center|
3W(*2 ?)
|align=center|
4 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
Reduit mais présent
|align=center|
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8403.pdf PAM8403]
|align=center|
|-valign="top"
|align=center|
PAM8610
|align=center|
[[Fichier:PAM8610.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 10 W
|align=center|
8 Ω
|align=center|
7 - 15 V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8610.pdf PAM8610]
|align=center|
|-valign="top"
|align=center|
XPT8871
|align=center|
[[Fichier:XPT8871.jpg|centré|120px]]
|align=center|
Mono
|align=center|
3.5w
<br>
5w
|align=center|
3 Ω
<br>
2 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[[Media:XPT8871.pdf|XPT8871]]
|align=left|
*Bien pour la voix, pas top pour la musique
|-valign="top"
|align=center|
TDA8932
|align=center|
[[Fichier:TDA8932.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2*15W
|align=center|
4 Ω
|align=center|
Entre 10 V et 36 V (Rechercher quel est le plus optimal)
|align=center|
OUI
|align=center|
NON
|align=center|

|align=center|
[https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932]
|align=center|
|-valign="top"
|align=center|
TPA3110
|align=center|
[[Fichier:TPA3110.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
15W/ch
|align=center|
8 Ω
|align=center|
16 V
|align=center|
OUI
|align=center|
NON
|align=center|
OUI
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3110d2.pdf TPA3110]
|align=left|
*Amplification moyenne
*Basses creuses
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3116
|align=center|
[[Fichier:TPA3116.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 50W<br>
2 x 15W
|align=center|
4 Ω<br>
8 Ω
|align=center|
21 V<br>
15 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI<br>
NON
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3116d2.pdf TPA3116]
|align=left|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3118
|align=center|
[[Fichier:TPA3118.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 30W
|align=center|
8 Ω
|align=center|
12 - 24 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI
|align=left|
[http://www.ti.com/lit/ds/symlink/tpa3118d2.pdf TPA3118]
|align=center|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|}
</div>

= Potentiomètre digital =
A faire

= Décodeur MP3 =
==Présentation==
Le décodeur MP3 choisi est le VS1053

[[Fichier:vs1053_board.jpg|centré|200px]]

Ce décodeur offre une interface SPI et permet de lire ainsi que d'enregistrer des fichiers aux formats :
* lecture :
**MP3 ;
**Ogg Vorbis (libre de droit) ;
**PCM;
**WAV;
* enregistrement :
**Ogg Vorbis(libre de droit) ;

==Documentation technique==
Voici la [[:Media:vs1053_doc.pdf|documentation du VS1053]], pour ceux qui voudraient écrire une librairie C++ !

== Schéma ==
Les tests ont été réalisés avec un WemOS D1 mini (ESP8266) :
<div align="center">
{|class="wikitable" width="85%"
! ESP8266 !! VS1053 !! Connections
|-valign=top
||
[[Fichier:wemos_D1_R2_mini_diagram.png|centré|470px]]
||
[[Fichier:vs1053_board_diagram.png|centré|300px]]
|align="center"|
{|class="wikitable"
! ESP8266 !! VS1053
|-
|align="center"| D0
|align="center"| XDCS
|-
|align="center"| D1
|align="center"| XoS (Cable Select)
|-
|align="center"| D3
|align="center"| DREQ
|-
|align="center"| D5
|align="center"| SCK (Serial ClocK)
|-
|align="center"| D6
|align="center"| MISO (Master In Slave Out)
|-
|align="center"| D7
|align="center"| MOSI (Master Out Slave In)
|-
|align="center"| RST
|align="center"| XRST
|-
|align="center"| 5V
|align="center"| 5V
|-
|align="center"| G
|align="center"| DGND
|}
|}
</div>
Vous devriez avoir quelque chose comme ça :

[[Fichier:wemos_D1_vs1053_diagram.jpg|centré|400px]]

== Programmation ==
Tout d'abord un grand merci à [https://github.com/baldram/ESP_VS1053_Library ''baldram''] pour sa [[Media:ESP_VS1053_Library.zip|librairie]] que nous allons utiliser !

Le plus simple est de regarder l'exemple ''SimpleMP3Player'' fourni avec la librairie :
<source lang="c">
// La fameuse librairie de baldram
#include <VS1053.h>
// Un MP3 au format binaire dans un tableau (le fichier est livré avec la librairie)
#include <helloMp3.h>
// Définition des port SPI utilisé (ici pour l'ESP8266)
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
// Définition du volume
#define VOLUME 80 // volume level 0-100
// Création de l'objet VS1053
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);

void setup () {
// Démarrage du SPI
SPI.begin();
// démarrage du VS1053
player.begin();
// Ligne nécessaire pour certain lecteur
player.switchToMp3Mode();
player.setVolume(VOLUME);
}

void loop() {
// On joue le MP3 dans le tableau
player.playChunk(helloMp3, sizeof(helloMp3));
// On attend 3 secondes
delay(3000);
}
</source>
Pour que cet exemple fonctionne, il faut soit copier le contenu de ''HelloMp3.h'' dans le fichier exemple, soit copier le fichier dans le répertoire de la librairie dans votre dossier ''Arduino''.

Une fois la compilation terminée, vous devriez entendre ''du bruit'' sortir du VS1053 !

= Flux musical =
La communication se fera en générant un flux entre le programme (PC) et l'enceinte (ESP8266). Ce flux, pour des raisons de simplicité, se fera en TCP car ce protocole gère les retransmissions, les tampons d'entrée / sortie, etc...

A terme, une application temps réel comme la musique mériterait de passer sur de l'UDP. Surtout que, si l'on souhaite utiliser du [https://www.tala-informatique.fr/wiki/index.php/Esp8266_udp_server multicast], pour parler à un groupe d'enceintes, on ne peut le faire qu'en UDP !
== Envoi : serveur en PHP ==
La partie serveur prend un fichier, ici un MP3, lit un morceau du fichier et l'envoi à l'enceinte à travers une socket TCP. Deux paramètres sont à prendre en compte :
*le temps d'attente entre chaque envoi;
*la taille d'un morceau;
Ces paramètres nécessiteront certainement un temps d'ajustement qui sera en fonction de la latence, la congestion du réseau, les capacités des puces impliquées (ici l'ESP8266), etc...
{|style="width:650px" align="center"
|
[[Fichier:warning-icon.png|centré|60px]]
|valign="top" align="justify"|
Les extraits de code qui vont suivre respectent vaguement les préceptes, au combien importants, de la programmation orientée objet et sont fournis à titre indicatif dans l'unique but de démontrer la faisabilité d'un tel projet ! Voici [[:Media:Iot_Speaker.zip | l'archive]] qui contient le code exposé ci-dessous.
|}
=== MusicSender ===
Voici le contenu du fichier ''MusicSender.class.php'' :
<source lang="php">
<?php

class MusicSender
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5045;

// Le temps d'attente en microsecondes entre chaque paquets
private static $SLEEP_INTERVAL = 2500;

// La taille de chacun des paquets
private static $CHUNK_BUFFER = 32768;

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Envoie le MP3 à l'enceinte
*
* @param string $mp3File
* @return boolean
*/
public function play($mp3File)
{
if (is_file($mp3File)) {
// Ouverture du fichier en lecture binaire
$file = fopen($mp3File, 'rb');
if ($file === FALSE) {
echo "Fail reading file " . $file . "\n";
return FALSE;
}
// Ouverture de la socket
$socket = $this->openSocket();
// Tant qu'on est pas à la fin du fichier
while (! feof($file)) {
// Envoie d'un "morceau" de taille CHUNK_BUFFER à l'enceinte
if (@socket_write($this->socket, fread($file, self::$CHUNK_BUFFER), self::$CHUNK_BUFFER) === FALSE) {
// Problème de socket (fermeture, déconnexion, etc...)
return FALSE;
}
usleep(self::$SLEEP_INTERVAL);
}
// Fermeture de la socket
$this->closeSocket();
// Fermeture du fichier
fclose($file);
return TRUE;
}
echo $file." does not exists !\n";
return FALSE;
}

/**
* Lit tous les mp3 présents dans le dossier
*
* @param string $dir
*/
public function readFolder($dir)
{
if (is_dir($dir)) {
// On récupére les fichiers sans les 2 premiers '.' et '..'
$files = array_slice(scandir($dir), 2);
foreach ($files as $file) {
// On créé le chemin absolu
$mp3File = $dir . DIRECTORY_SEPARATOR . $file;
// On test l'extension
if (pathinfo($file)["extension"] == "mp3") {
$this->play($mp3File);
}
}
return true;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) == FALSE) {
echo "socket_create_listen() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
if (socket_connect($this->socket, $this->ip, self::$PORT) == FALSE) {
echo "socket_bind() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
=== Launch.php ===
On créé un fichier ''Launch.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicSender.class.php';

$esp_ip = "192.168.1.200";

$dir = "!!chemin_vers_des_fichiers_mp3!!";

$sender = new MusicSender($esp_ip);

$sender->readFolder($dir);
</source>

== Réception : ESP8266 ==
{|style="width:650px" align="center"
|
[[Fichier:Warning manual.jpg|centré|300px]]
|valign="top" align="justify"|
Soyez sûr de comprendre la section sur [https://www.tala-informatique.fr/wiki/index.php/Arduino_sketch_writing| comment écrire un sketch] avant de poursuivre. Le code ci-dessous fait référence à des parties bien spécifiques, détaillées et expliquées dans la section suscitée.
|}
=== Partie WiFi ===
La première étape consiste à raccorder notre ''ESP'' au réseau WiFi !
<source lang="c">
#include <ESP8266WiFi.h>
#include <WiFiClient.h>

// WiFi Parameters //
const char ssid[] = "cfcasa";
const char password[] = "***********";
IPAddress ip(192, 168, 1, 200);
IPAddress gw(192, 168, 1, 254);
IPAddress mask(255, 255, 252, 0);

void setup() {
// on démarre le port série
Serial.begin(115200);
// On attend "un peu" que le buffer soit prêt
delay(10);
// On démarre le WiFi
initWiFi();
}

void loop() {
}

void initWiFi() {
// On efface la configuration précédente
WiFi.disconnect(true);
Serial.printf("\nConnexion a %s", ssid);
// Initialisation de la connection
WiFi.config(ip, gw, mask, gw);
WiFi.begin(ssid, password);
// Test pour déterminer quand la connection est prete
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(".");
}
// Affichage des informations
Serial.printf(" connecté\nAdresse IP: %s\n", WiFi.localIP().toString().c_str());
}
</source>
=== Lecteur MP3 ===
Vient ensuite la partie du lecteur MP3. Dans la partie des imports, ajoutez la ligne suivante :
<source lang="c">
#include <VS1053.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Parameters //
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
#define VOLUME 70 // volume level 0-100
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);
uint8_t volume_level = VOLUME;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le shield MP3
initMP3();
</source>
A la suite, on insère la fonction suivante :
<source lang="c">
void initMP3() {
SPI.begin();
// Démarrage du lecteur MP3
player.begin();
player.switchToMp3Mode();
player.setVolume(volume_level);
}
</source>
=== Récupération du stream MP3 ===
On va maintenant récupérer le flux envoyé depuis le serveur. Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Server parameters //
const uint16_t MP3_PORT = 5045;
WiFiServer server(MP3_PORT);
const uint16_t BUFFER_SIZE = 16384;
//const uint16_t BUFFER_SIZE = 32768;
byte buffer[BUFFER_SIZE + 1];
uint16_t byteRead = 0;
bool isBufferReady = false;
WiFiClient client;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur TCP
initMp3Server();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
void initMp3Server() {
// Démarrage du serveur TCP
server.begin();
Serial.printf("Ecoute TCP sur le port %d\n", MP3_PORT);
}

void readMp3() {
// Un client est connecté
if (client) {
// Si le client est toujours connecté...
if (client.connected()) {
// Tant que l'on reçoit de la musique
while (client.available() > 0) {
// On rempli le buffer avec le contenu du paquet TCP
buffer[byteRead++] = client.read();
// Si le buffer est plein
if (byteRead == BUFFER_SIZE) {
// On previent que le buffer est plein
isBufferReady = true;
// On sort de la boucle
break;
}
}
// Si le buffer est plein
if (isBufferReady) {
// On envoi tout au lecteur MP3
player.playChunk(buffer, byteRead);
// On RAZ le compteur de bytes
byteRead = 0;
}
} else {
// Si le client est déconneté
client = server.available();
// On prévient que le buffer est vide
isBufferReady = false;
// On RAZ le compteur de bytes
byteRead = 0;
Serial.println(F("Client disconnected"));
}
} else {
// On test la présence d'un client
client = server.available();
if (client) {
// Un client est connecté !
Serial.println(F("New client !"));
}
}
}
</source>
Enfin, on ajoute le ligne suivante dans la fonction ''loop()'' :
<source lang="c">
readMp3();
</source>
A ce stade, l'ESP devrait être capable de récupérer le flux et de le jouer !

= Envoi de commandes =
Envoyer de la musique c'est bien, pouvoir régler le volume c'est encore mieux !

La façon la plus simple d'adresser le problème c'est d'utiliser un autre port et, comme les messages sont petits, d'utiliser UDP.
== Partie Serveur ==
Dans la même veine, voici la classe qui permet d'envoyer les commandes :
<source lang="php">
<?php

class MusicHandler
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5046;

// Le port de l'enceinte connectée
private static $RETRIES = 3;

// Liste de commandes
private static $CMD_VOLUME = 'V';

private static $CMD_LOCATE = 'L';

private static $CMD_RESET = 'R';

private static $RESPONSE_NOK = 'N';

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Augmente le volume d'un incrément
*
* @return boolean
*/
public function volumeUp()
{
return $this->sendCommand(self::$CMD_VOLUME . "+");
}

/**
* Baisse le volume d'un incrément
*
* @return boolean
*/
public function volumeDown()
{
return $this->sendCommand(self::$CMD_VOLUME . "-");
}

/**
*
* @return boolean
*/
public function setVolume($volume)
{
if ($volume < 0 || $volume > 100) {
return false;
}
return $this->sendCommand(self::$CMD_VOLUME . $volume);
}

public function getVolume(){
return $this->sendCommand(self::$CMD_VOLUME);
}

/**
*
* @return boolean
*/
public function doReset()
{
return $this->sendCommand(self::$CMD_RESET);
}

public function doLocate(){
return $this->sendCommand(self::$CMD_LOCATE);
}

/**
* Envoie une commande au module
*
* @param string $message
*/
private function sendCommand($message)
{
$result = false;
if ($this->openSocket() !== FALSE) {
if (socket_sendto($this->socket, $message, strlen($message), 0, $this->ip, self::$PORT) !== FALSE) {
$result = $this->readAcknoledge();
}
}
$this->closeSocket();
return $result;
}

/**
* Attend la confirmation de la commande
*
* @return boolean
*/
private function readAcknoledge()
{
$buf = "";
$retries = 0;
while ($retries < self::$RETRIES) {
$byteReceived = socket_recvfrom($this->socket, $buf, 2048, 0, $this->ip, self::$PORT);
if ($byteReceived > 0) {
return $buf != self::$RESPONSE_NOK ? $buf : FALSE;
}
usleep(500000);
$retries ++;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) === FALSE) {
$errorcode = socket_last_error();
$errormsg = socket_strerror($errorcode);
echo ("Couldn't create socket: [$errorcode] $errormsg \n");
return false;
}
return true;
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
On créé un fichier ''Command.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicHandler.class.php';

$esp_ip = "192.168.1.200";

$handler = new MusicHandler($esp_ip);

// Exemple de commandes //
//$result = $handler->volumeUp();
//$result = $handler->getVolume();
//$result = $handler->doReset();
//$result = $handler->setVolume(70);

$result = $handler->doLocate();

echo $result !== FALSE ? "ok : $result\n" : "nok\n";
</source>
== Partie Cliente ==
Dans la partie des imports ajoutez la ligne suivante :
<source lang="c">
#include <WiFiUDP.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// Command Server parameters //
const uint16_t CMD_PORT = 5046;
// L'instance du serveur UDP
WiFiUDP udp;
// Liste de commandes
const char CMD_VOLUME = 'V';
const char CMD_LOCATE = 'L';
const char CMD_RESET = 'R';
const char RESPONSE_NOK[] = "N";

// Localisation parameters
uint8_t ledPin = LED_BUILTIN;
const uint16_t BLINK_FREQ = 500;
const uint8_t BLINK_REP = 60;
uint8_t repetition = 0;
uint32_t timer;
bool isLocate = false;
</source>
A la fin de la fonction setup() nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur UDP
initCmdServer();
// On prépare la led de localisation
initLocateLed();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
bool readCmd() {
if (udp.parsePacket() > 0) {
uint8_t len = udp.available();
char c = udp.read();
if (len == 1) {
if (c == CMD_RESET) {
player.softReset();
sendPacket(CMD_RESET);
return true;
} else if (c == CMD_VOLUME) {
sendPacket(volume_level);
return true;
} else if (c == CMD_LOCATE) {
if (!isLocate) {
locate(true);
sendPacket(CMD_LOCATE);
return true;
}
}
} else if (len == 2) {
char value = udp.read();
if (c == CMD_VOLUME) {
if (value == '+' && volume_level != 100) {
setVolume(volume_level + 1);
} else if (value == '-' && volume_level != 0) {
setVolume(volume_level - 1);
} else {
sendNack();
return false;
}
return true;
}
} else {
if (c == CMD_VOLUME) {
char value[4] = "0";
udp.read(value, 3);
uint8_t vol = atoi(value);
if (vol >= 0 && vol <= 100) {
setVolume(vol);
return true;
}
}
}
sendNack();
return false;
}
// Check if locate needs to be done
locate(false);
}
void locate(bool blink) {
if (blink) {
// Initialisation des variables
digitalWrite(ledPin, LOW);
isLocate = true;
repetition = 0;
timer = millis();
} else if (isLocate) {
// Calcule du temps
uint32_t elapsed = millis() - timer;
if (elapsed > BLINK_FREQ) {
repetition++;
if (repetition == BLINK_REP) {
// On a atteint le nombre de clignotements
isLocate = false;
digitalWrite(ledPin, HIGH);
} else {
// On fait clignoter la led
digitalWrite(ledPin, !digitalRead(ledPin));
timer = millis();
}
}
}
}

void setVolume(uint8_t vol) {
volume_level = vol;
Serial.printf("Setting volume to %d\n", volume_level);
player.setVolume(volume_level);
sendPacket(volume_level);
}

void sendNack() {
sendPacket(RESPONSE_NOK);
}

void sendPacket(const char content) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(const char content[]) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(int content) {
char value[4];
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(itoa(content, value, 10));
udp.endPacket();
}

void initCmdServer() {
// Démarrage du serveur TCP
udp.begin(CMD_PORT);
Serial.printf("Ecoute UDP sur le port %d\n", CMD_PORT);
}

void initLocateLed() {
pinMode(ledPin, OUTPUT);
digitalWrite(ledPin, HIGH);
}
</source>
L'ESP est maintenant capable de :
* monter / baisser le volume ;
* de faire un reset du lecteur MP3 (en cas de problème)
* de faire clignoter sa led pour être localisé facilement.

= Enceinte armbian =
Même objectif mais cette fois-ci avec Rygel, un lecteur DLNA.
==Installation ==
Le système:
<pre>
# apt-get update
</pre>
Le lecteur rygel:
<pre>
# apt-get -y install rygel-playbin
</pre>
Les différents plugins. Tout d'abord, récupérer les plugins en fonctions de la distribution:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | awk -F ' - ' '{print $1}')
# apt-get install ${plugins}
</pre>
Ensuite on procéde à l'installation:
<pre>
# apt-get install ${plugins}
</pre>
== Création du fichier de service ==
Il suffit de créer le fichier ''/etc/systemd/system/rygel.service'':
<pre>
[Unit]
Description=Rygel service
After=network-online.target

[Service]
Type=simple
UMask=007
ExecStart=/usr/bin/rygel -g 5
Restart=on-failure

# Configures the time to wait before service is stopped forcefully.
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
On peut lancer le service et l'activer au démarrage
<pre>
# systemctl start rygel
# systemctl enable rygel
</pre>
== Désactivation des logs ==
Comme l'enceinte n'est pas à proprement parler un serveur exécutant un service critique, on peut désactiver le système de logging pour économiser la durée de vie de la carte SD:
<pre>
# systemctl stop rsyslog
# systemctl disable rsyslog
</pre>
== Ajustement du volume ==
Il faut maintenant mettre le volume au maximum coté Pi avec le mixer ALSA [https://fr.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture wikipedia] :
<pre>
# alsamixer
</pre>
[[Fichier:alsamixer armbian.png|centré]]
== Changement de la carte son par défaut ==
Une fois la carte son USB installée, il suffit d'utiliser la commande suivante pour voir son identifiant:
<pre>
# aplay -l
**** List of PLAYBACK Hardware Devices ****
card 0: sun4icodec [sun4i-codec], device 0: CDC PCM Codec-0 []
Subdevices: 1/1
Subdevice #0: subdevice #0
card 1: Device [USB Audio Device], device 0: USB Audio [USB Audio]
Subdevices: 0/1
Subdevice #0: subdevice #0
</pre>
La carte son avec l'ID ''0'' est celle intégrée au PI, celle avec l'ID ''1'' est la carte USB.
Pour dire à ALSA que c'est la carte avec l'ID ''1'' que l'on veut par défaut, il suffit de créer le fichier ''/etc/asound.conf'' avec les lignes suivantes:
<pre>
defaults.pcm.card 1
defaults.ctl.card 1
</pre>
La configuration est appliquée après un redémarrage !

== Installation de WiringPI==
<pre>
# cd /opt
# git clone https://github.com/LeMaker/WiringLMK.git
# cd WiringLMK
# chmod +x ./build
# ./build
</pre>

== Ajout du bluetooth ==
Il faut d'abord installer blueZ:
<pre>
# apt-get install -y bluez bluez-tools
</pre>

Iot speaker

2019-07-16T10:26:24Z

Tala : /* Ajustement du volume */

=Projet=
{|class="wikitable" width="100%"
|-valign=top
! Objectif !! Les acteurs !! Compétences !! Matériel
|-valign=top
||
Construire des enceintes sans-fils (sauf le courant) actives connectées capables de travailler en "groupe"
||
*[[User:Tala | Tala]]
*[[User:Nigdor |Nigdor]]
*[[User:Prandar |Prandar]]
||
*électronique
*C++ (microcontrôleur)
||
* microcontrôleur (esp8266)
* amplificateur audio (XPT8871, PAM8403, ...)
* décodeur MP3 (VS1053B)
* potentiomètre digital (X9C103S)
|}

= Choix de l'amplificateur =
A faire:
*Expliquer la différence entre classe AB et D (qualité sonore vs. éco énergie)
*Faire un tableau récapitulatif des caractéristiques des amplis:
** mono / stéréo / les deux
** tension de fonctionnement / consommation (5v, 12v, 24v, etc...)
** puissance (5w, 20w, 30w, etc...)
** impédance de sortie (2 x 4Ω, 1 x 8Ω, etc...)
** réponse fréquentielle ;
** résistance aux courts-circuits ;
** bruit pop (quand pas de musique);
** besoin d'un dissipateur ou non (effet joule à prévoir...)
** lien vers la documentation si besoin d'info(eg. pour le [https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932])
** le plus important : le ressenti !
==Classe AB==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
TDA7297
|align=center|
[[Fichier:TDA7297.png|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 15W
|align=center|
2A (peak)
|align=center|
6 - 18 V
|align=center|
OUI
|align=center|
Avec µControlleur<br>(p. 3/4)
|align=center|
Obligatoire
|align=center|
[http://www.st.com/content/ccc/resource/technical/document/datasheet/a3/eb/9b/59/dd/26/4a/27/CD00001048.pdf/files/CD00001048.pdf/jcr:content/translations/en.CD00001048.pdf TDA7297]
|align=left|
Super amplification sans distorsion !
<br>
Forte dissipation thermique à pleine puissance :
* 33W d'après la doc;
* vraiment très (trop) fort !
|}
</div>

==Classe D==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
XH-M531 (YDA138)
|align=center|
[[Fichier:XH-M531.jpg|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 10 W<br>
2 x 20 W
|align=center|
8 Ω<br>
4 Ω
|align=center|
12 - 15V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.ksp-electronics.com/product_files/8eeedc66ea8fbcdf2e74294037c2f389 YDA138]
|align=center|
|-valign="top"
|align=center|
PAM8403
|align=center|
[[Fichier:PAM8403.jpg|centré|100px]]
|align=center|
Stéréo
|align=center|
3W(*2 ?)
|align=center|
4 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
Reduit mais présent
|align=center|
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8403.pdf PAM8403]
|align=center|
|-valign="top"
|align=center|
PAM8610
|align=center|
[[Fichier:PAM8610.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 10 W
|align=center|
8 Ω
|align=center|
7 - 15 V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8610.pdf PAM8610]
|align=center|
|-valign="top"
|align=center|
XPT8871
|align=center|
[[Fichier:XPT8871.jpg|centré|120px]]
|align=center|
Mono
|align=center|
3.5w
<br>
5w
|align=center|
3 Ω
<br>
2 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[[Media:XPT8871.pdf|XPT8871]]
|align=left|
*Bien pour la voix, pas top pour la musique
|-valign="top"
|align=center|
TDA8932
|align=center|
[[Fichier:TDA8932.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2*15W
|align=center|
4 Ω
|align=center|
Entre 10 V et 36 V (Rechercher quel est le plus optimal)
|align=center|
OUI
|align=center|
NON
|align=center|

|align=center|
[https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932]
|align=center|
|-valign="top"
|align=center|
TPA3110
|align=center|
[[Fichier:TPA3110.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
15W/ch
|align=center|
8 Ω
|align=center|
16 V
|align=center|
OUI
|align=center|
NON
|align=center|
OUI
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3110d2.pdf TPA3110]
|align=left|
*Amplification moyenne
*Basses creuses
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3116
|align=center|
[[Fichier:TPA3116.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 50W<br>
2 x 15W
|align=center|
4 Ω<br>
8 Ω
|align=center|
21 V<br>
15 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI<br>
NON
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3116d2.pdf TPA3116]
|align=left|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3118
|align=center|
[[Fichier:TPA3118.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 30W
|align=center|
8 Ω
|align=center|
12 - 24 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI
|align=left|
[http://www.ti.com/lit/ds/symlink/tpa3118d2.pdf TPA3118]
|align=center|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|}
</div>

= Potentiomètre digital =
A faire

= Décodeur MP3 =
==Présentation==
Le décodeur MP3 choisi est le VS1053

[[Fichier:vs1053_board.jpg|centré|200px]]

Ce décodeur offre une interface SPI et permet de lire ainsi que d'enregistrer des fichiers aux formats :
* lecture :
**MP3 ;
**Ogg Vorbis (libre de droit) ;
**PCM;
**WAV;
* enregistrement :
**Ogg Vorbis(libre de droit) ;

==Documentation technique==
Voici la [[:Media:vs1053_doc.pdf|documentation du VS1053]], pour ceux qui voudraient écrire une librairie C++ !

== Schéma ==
Les tests ont été réalisés avec un WemOS D1 mini (ESP8266) :
<div align="center">
{|class="wikitable" width="85%"
! ESP8266 !! VS1053 !! Connections
|-valign=top
||
[[Fichier:wemos_D1_R2_mini_diagram.png|centré|470px]]
||
[[Fichier:vs1053_board_diagram.png|centré|300px]]
|align="center"|
{|class="wikitable"
! ESP8266 !! VS1053
|-
|align="center"| D0
|align="center"| XDCS
|-
|align="center"| D1
|align="center"| XoS (Cable Select)
|-
|align="center"| D3
|align="center"| DREQ
|-
|align="center"| D5
|align="center"| SCK (Serial ClocK)
|-
|align="center"| D6
|align="center"| MISO (Master In Slave Out)
|-
|align="center"| D7
|align="center"| MOSI (Master Out Slave In)
|-
|align="center"| RST
|align="center"| XRST
|-
|align="center"| 5V
|align="center"| 5V
|-
|align="center"| G
|align="center"| DGND
|}
|}
</div>
Vous devriez avoir quelque chose comme ça :

[[Fichier:wemos_D1_vs1053_diagram.jpg|centré|400px]]

== Programmation ==
Tout d'abord un grand merci à [https://github.com/baldram/ESP_VS1053_Library ''baldram''] pour sa [[Media:ESP_VS1053_Library.zip|librairie]] que nous allons utiliser !

Le plus simple est de regarder l'exemple ''SimpleMP3Player'' fourni avec la librairie :
<source lang="c">
// La fameuse librairie de baldram
#include <VS1053.h>
// Un MP3 au format binaire dans un tableau (le fichier est livré avec la librairie)
#include <helloMp3.h>
// Définition des port SPI utilisé (ici pour l'ESP8266)
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
// Définition du volume
#define VOLUME 80 // volume level 0-100
// Création de l'objet VS1053
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);

void setup () {
// Démarrage du SPI
SPI.begin();
// démarrage du VS1053
player.begin();
// Ligne nécessaire pour certain lecteur
player.switchToMp3Mode();
player.setVolume(VOLUME);
}

void loop() {
// On joue le MP3 dans le tableau
player.playChunk(helloMp3, sizeof(helloMp3));
// On attend 3 secondes
delay(3000);
}
</source>
Pour que cet exemple fonctionne, il faut soit copier le contenu de ''HelloMp3.h'' dans le fichier exemple, soit copier le fichier dans le répertoire de la librairie dans votre dossier ''Arduino''.

Une fois la compilation terminée, vous devriez entendre ''du bruit'' sortir du VS1053 !

= Flux musical =
La communication se fera en générant un flux entre le programme (PC) et l'enceinte (ESP8266). Ce flux, pour des raisons de simplicité, se fera en TCP car ce protocole gère les retransmissions, les tampons d'entrée / sortie, etc...

A terme, une application temps réel comme la musique mériterait de passer sur de l'UDP. Surtout que, si l'on souhaite utiliser du [https://www.tala-informatique.fr/wiki/index.php/Esp8266_udp_server multicast], pour parler à un groupe d'enceintes, on ne peut le faire qu'en UDP !
== Envoi : serveur en PHP ==
La partie serveur prend un fichier, ici un MP3, lit un morceau du fichier et l'envoi à l'enceinte à travers une socket TCP. Deux paramètres sont à prendre en compte :
*le temps d'attente entre chaque envoi;
*la taille d'un morceau;
Ces paramètres nécessiteront certainement un temps d'ajustement qui sera en fonction de la latence, la congestion du réseau, les capacités des puces impliquées (ici l'ESP8266), etc...
{|style="width:650px" align="center"
|
[[Fichier:warning-icon.png|centré|60px]]
|valign="top" align="justify"|
Les extraits de code qui vont suivre respectent vaguement les préceptes, au combien importants, de la programmation orientée objet et sont fournis à titre indicatif dans l'unique but de démontrer la faisabilité d'un tel projet ! Voici [[:Media:Iot_Speaker.zip | l'archive]] qui contient le code exposé ci-dessous.
|}
=== MusicSender ===
Voici le contenu du fichier ''MusicSender.class.php'' :
<source lang="php">
<?php

class MusicSender
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5045;

// Le temps d'attente en microsecondes entre chaque paquets
private static $SLEEP_INTERVAL = 2500;

// La taille de chacun des paquets
private static $CHUNK_BUFFER = 32768;

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Envoie le MP3 à l'enceinte
*
* @param string $mp3File
* @return boolean
*/
public function play($mp3File)
{
if (is_file($mp3File)) {
// Ouverture du fichier en lecture binaire
$file = fopen($mp3File, 'rb');
if ($file === FALSE) {
echo "Fail reading file " . $file . "\n";
return FALSE;
}
// Ouverture de la socket
$socket = $this->openSocket();
// Tant qu'on est pas à la fin du fichier
while (! feof($file)) {
// Envoie d'un "morceau" de taille CHUNK_BUFFER à l'enceinte
if (@socket_write($this->socket, fread($file, self::$CHUNK_BUFFER), self::$CHUNK_BUFFER) === FALSE) {
// Problème de socket (fermeture, déconnexion, etc...)
return FALSE;
}
usleep(self::$SLEEP_INTERVAL);
}
// Fermeture de la socket
$this->closeSocket();
// Fermeture du fichier
fclose($file);
return TRUE;
}
echo $file." does not exists !\n";
return FALSE;
}

/**
* Lit tous les mp3 présents dans le dossier
*
* @param string $dir
*/
public function readFolder($dir)
{
if (is_dir($dir)) {
// On récupére les fichiers sans les 2 premiers '.' et '..'
$files = array_slice(scandir($dir), 2);
foreach ($files as $file) {
// On créé le chemin absolu
$mp3File = $dir . DIRECTORY_SEPARATOR . $file;
// On test l'extension
if (pathinfo($file)["extension"] == "mp3") {
$this->play($mp3File);
}
}
return true;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) == FALSE) {
echo "socket_create_listen() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
if (socket_connect($this->socket, $this->ip, self::$PORT) == FALSE) {
echo "socket_bind() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
=== Launch.php ===
On créé un fichier ''Launch.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicSender.class.php';

$esp_ip = "192.168.1.200";

$dir = "!!chemin_vers_des_fichiers_mp3!!";

$sender = new MusicSender($esp_ip);

$sender->readFolder($dir);
</source>

== Réception : ESP8266 ==
{|style="width:650px" align="center"
|
[[Fichier:Warning manual.jpg|centré|300px]]
|valign="top" align="justify"|
Soyez sûr de comprendre la section sur [https://www.tala-informatique.fr/wiki/index.php/Arduino_sketch_writing| comment écrire un sketch] avant de poursuivre. Le code ci-dessous fait référence à des parties bien spécifiques, détaillées et expliquées dans la section suscitée.
|}
=== Partie WiFi ===
La première étape consiste à raccorder notre ''ESP'' au réseau WiFi !
<source lang="c">
#include <ESP8266WiFi.h>
#include <WiFiClient.h>

// WiFi Parameters //
const char ssid[] = "cfcasa";
const char password[] = "***********";
IPAddress ip(192, 168, 1, 200);
IPAddress gw(192, 168, 1, 254);
IPAddress mask(255, 255, 252, 0);

void setup() {
// on démarre le port série
Serial.begin(115200);
// On attend "un peu" que le buffer soit prêt
delay(10);
// On démarre le WiFi
initWiFi();
}

void loop() {
}

void initWiFi() {
// On efface la configuration précédente
WiFi.disconnect(true);
Serial.printf("\nConnexion a %s", ssid);
// Initialisation de la connection
WiFi.config(ip, gw, mask, gw);
WiFi.begin(ssid, password);
// Test pour déterminer quand la connection est prete
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(".");
}
// Affichage des informations
Serial.printf(" connecté\nAdresse IP: %s\n", WiFi.localIP().toString().c_str());
}
</source>
=== Lecteur MP3 ===
Vient ensuite la partie du lecteur MP3. Dans la partie des imports, ajoutez la ligne suivante :
<source lang="c">
#include <VS1053.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Parameters //
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
#define VOLUME 70 // volume level 0-100
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);
uint8_t volume_level = VOLUME;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le shield MP3
initMP3();
</source>
A la suite, on insère la fonction suivante :
<source lang="c">
void initMP3() {
SPI.begin();
// Démarrage du lecteur MP3
player.begin();
player.switchToMp3Mode();
player.setVolume(volume_level);
}
</source>
=== Récupération du stream MP3 ===
On va maintenant récupérer le flux envoyé depuis le serveur. Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Server parameters //
const uint16_t MP3_PORT = 5045;
WiFiServer server(MP3_PORT);
const uint16_t BUFFER_SIZE = 16384;
//const uint16_t BUFFER_SIZE = 32768;
byte buffer[BUFFER_SIZE + 1];
uint16_t byteRead = 0;
bool isBufferReady = false;
WiFiClient client;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur TCP
initMp3Server();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
void initMp3Server() {
// Démarrage du serveur TCP
server.begin();
Serial.printf("Ecoute TCP sur le port %d\n", MP3_PORT);
}

void readMp3() {
// Un client est connecté
if (client) {
// Si le client est toujours connecté...
if (client.connected()) {
// Tant que l'on reçoit de la musique
while (client.available() > 0) {
// On rempli le buffer avec le contenu du paquet TCP
buffer[byteRead++] = client.read();
// Si le buffer est plein
if (byteRead == BUFFER_SIZE) {
// On previent que le buffer est plein
isBufferReady = true;
// On sort de la boucle
break;
}
}
// Si le buffer est plein
if (isBufferReady) {
// On envoi tout au lecteur MP3
player.playChunk(buffer, byteRead);
// On RAZ le compteur de bytes
byteRead = 0;
}
} else {
// Si le client est déconneté
client = server.available();
// On prévient que le buffer est vide
isBufferReady = false;
// On RAZ le compteur de bytes
byteRead = 0;
Serial.println(F("Client disconnected"));
}
} else {
// On test la présence d'un client
client = server.available();
if (client) {
// Un client est connecté !
Serial.println(F("New client !"));
}
}
}
</source>
Enfin, on ajoute le ligne suivante dans la fonction ''loop()'' :
<source lang="c">
readMp3();
</source>
A ce stade, l'ESP devrait être capable de récupérer le flux et de le jouer !

= Envoi de commandes =
Envoyer de la musique c'est bien, pouvoir régler le volume c'est encore mieux !

La façon la plus simple d'adresser le problème c'est d'utiliser un autre port et, comme les messages sont petits, d'utiliser UDP.
== Partie Serveur ==
Dans la même veine, voici la classe qui permet d'envoyer les commandes :
<source lang="php">
<?php

class MusicHandler
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5046;

// Le port de l'enceinte connectée
private static $RETRIES = 3;

// Liste de commandes
private static $CMD_VOLUME = 'V';

private static $CMD_LOCATE = 'L';

private static $CMD_RESET = 'R';

private static $RESPONSE_NOK = 'N';

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Augmente le volume d'un incrément
*
* @return boolean
*/
public function volumeUp()
{
return $this->sendCommand(self::$CMD_VOLUME . "+");
}

/**
* Baisse le volume d'un incrément
*
* @return boolean
*/
public function volumeDown()
{
return $this->sendCommand(self::$CMD_VOLUME . "-");
}

/**
*
* @return boolean
*/
public function setVolume($volume)
{
if ($volume < 0 || $volume > 100) {
return false;
}
return $this->sendCommand(self::$CMD_VOLUME . $volume);
}

public function getVolume(){
return $this->sendCommand(self::$CMD_VOLUME);
}

/**
*
* @return boolean
*/
public function doReset()
{
return $this->sendCommand(self::$CMD_RESET);
}

public function doLocate(){
return $this->sendCommand(self::$CMD_LOCATE);
}

/**
* Envoie une commande au module
*
* @param string $message
*/
private function sendCommand($message)
{
$result = false;
if ($this->openSocket() !== FALSE) {
if (socket_sendto($this->socket, $message, strlen($message), 0, $this->ip, self::$PORT) !== FALSE) {
$result = $this->readAcknoledge();
}
}
$this->closeSocket();
return $result;
}

/**
* Attend la confirmation de la commande
*
* @return boolean
*/
private function readAcknoledge()
{
$buf = "";
$retries = 0;
while ($retries < self::$RETRIES) {
$byteReceived = socket_recvfrom($this->socket, $buf, 2048, 0, $this->ip, self::$PORT);
if ($byteReceived > 0) {
return $buf != self::$RESPONSE_NOK ? $buf : FALSE;
}
usleep(500000);
$retries ++;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) === FALSE) {
$errorcode = socket_last_error();
$errormsg = socket_strerror($errorcode);
echo ("Couldn't create socket: [$errorcode] $errormsg \n");
return false;
}
return true;
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
On créé un fichier ''Command.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicHandler.class.php';

$esp_ip = "192.168.1.200";

$handler = new MusicHandler($esp_ip);

// Exemple de commandes //
//$result = $handler->volumeUp();
//$result = $handler->getVolume();
//$result = $handler->doReset();
//$result = $handler->setVolume(70);

$result = $handler->doLocate();

echo $result !== FALSE ? "ok : $result\n" : "nok\n";
</source>
== Partie Cliente ==
Dans la partie des imports ajoutez la ligne suivante :
<source lang="c">
#include <WiFiUDP.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// Command Server parameters //
const uint16_t CMD_PORT = 5046;
// L'instance du serveur UDP
WiFiUDP udp;
// Liste de commandes
const char CMD_VOLUME = 'V';
const char CMD_LOCATE = 'L';
const char CMD_RESET = 'R';
const char RESPONSE_NOK[] = "N";

// Localisation parameters
uint8_t ledPin = LED_BUILTIN;
const uint16_t BLINK_FREQ = 500;
const uint8_t BLINK_REP = 60;
uint8_t repetition = 0;
uint32_t timer;
bool isLocate = false;
</source>
A la fin de la fonction setup() nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur UDP
initCmdServer();
// On prépare la led de localisation
initLocateLed();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
bool readCmd() {
if (udp.parsePacket() > 0) {
uint8_t len = udp.available();
char c = udp.read();
if (len == 1) {
if (c == CMD_RESET) {
player.softReset();
sendPacket(CMD_RESET);
return true;
} else if (c == CMD_VOLUME) {
sendPacket(volume_level);
return true;
} else if (c == CMD_LOCATE) {
if (!isLocate) {
locate(true);
sendPacket(CMD_LOCATE);
return true;
}
}
} else if (len == 2) {
char value = udp.read();
if (c == CMD_VOLUME) {
if (value == '+' && volume_level != 100) {
setVolume(volume_level + 1);
} else if (value == '-' && volume_level != 0) {
setVolume(volume_level - 1);
} else {
sendNack();
return false;
}
return true;
}
} else {
if (c == CMD_VOLUME) {
char value[4] = "0";
udp.read(value, 3);
uint8_t vol = atoi(value);
if (vol >= 0 && vol <= 100) {
setVolume(vol);
return true;
}
}
}
sendNack();
return false;
}
// Check if locate needs to be done
locate(false);
}
void locate(bool blink) {
if (blink) {
// Initialisation des variables
digitalWrite(ledPin, LOW);
isLocate = true;
repetition = 0;
timer = millis();
} else if (isLocate) {
// Calcule du temps
uint32_t elapsed = millis() - timer;
if (elapsed > BLINK_FREQ) {
repetition++;
if (repetition == BLINK_REP) {
// On a atteint le nombre de clignotements
isLocate = false;
digitalWrite(ledPin, HIGH);
} else {
// On fait clignoter la led
digitalWrite(ledPin, !digitalRead(ledPin));
timer = millis();
}
}
}
}

void setVolume(uint8_t vol) {
volume_level = vol;
Serial.printf("Setting volume to %d\n", volume_level);
player.setVolume(volume_level);
sendPacket(volume_level);
}

void sendNack() {
sendPacket(RESPONSE_NOK);
}

void sendPacket(const char content) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(const char content[]) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(int content) {
char value[4];
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(itoa(content, value, 10));
udp.endPacket();
}

void initCmdServer() {
// Démarrage du serveur TCP
udp.begin(CMD_PORT);
Serial.printf("Ecoute UDP sur le port %d\n", CMD_PORT);
}

void initLocateLed() {
pinMode(ledPin, OUTPUT);
digitalWrite(ledPin, HIGH);
}
</source>
L'ESP est maintenant capable de :
* monter / baisser le volume ;
* de faire un reset du lecteur MP3 (en cas de problème)
* de faire clignoter sa led pour être localisé facilement.

= Enceinte armbian =
Même objectif mais cette fois-ci avec Rygel, un lecteur DLNA.
==Installation ==
Le système:
<pre>
# apt-get update
</pre>
Le lecteur rygel:
<pre>
# apt-get -y install rygel-playbin
</pre>
Les différents plugins. Tout d'abord, récupérer les plugins en fonctions de la distribution:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | awk -F ' - ' '{print $1}')
# apt-get install ${plugins}
</pre>
Ensuite on procéde à l'installation:
<pre>
# apt-get install ${plugins}
</pre>
== Création du fichier de service ==
Il suffit de créer le fichier ''/etc/systemd/system/rygel.service'':
<pre>
[Unit]
Description=Rygel service
After=network-online.target

[Service]
Type=simple
UMask=007
ExecStart=/usr/bin/rygel -g 5
Restart=on-failure

# Configures the time to wait before service is stopped forcefully.
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
On peut lancer le service et l'activer au démarrage
<pre>
# systemctl start rygel
# systemctl enable rygel
</pre>
== Désactivation des logs ==
Comme l'enceinte n'est pas à proprement parler un serveur exécutant un service critique, on peut désactiver le système de logging pour économiser la durée de vie de la carte SD:
<pre>
# systemctl stop rsyslog
# systemctl disable rsyslog
</pre>
== Ajustement du volume ==
Il faut maintenant mettre le volume au maximum coté Pi avec le mixer ALSA [https://fr.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture wikipedia] :
<pre>
# alsamixer
</pre>
[[Fichier:alsamixer armbian.png|centré]]
== Changement de la carte son par défaut ==
Une fois la carte son USB installée, il suffit d'utiliser la commande suivante pour voir son identifiant:
<pre>
# aplay -l
**** List of PLAYBACK Hardware Devices ****
card 0: sun4icodec [sun4i-codec], device 0: CDC PCM Codec-0 []
Subdevices: 1/1
Subdevice #0: subdevice #0
card 1: Device [USB Audio Device], device 0: USB Audio [USB Audio]
Subdevices: 0/1
Subdevice #0: subdevice #0
</pre>
La carte son avec l'ID ''0'' est celle intégrée au PI, celle avec l'ID ''1'' est la carte USB.
Pour dire à ALSA que c'est la carte avec l'ID ''1'' que l'on veut par défaut, il suffit de créer le fichier ''/etc/asound.conf'' avec les lignes suivantes:
<pre>
defaults.pcm.card 1
defaults.ctl.card 1
</pre>
La configuration est appliquée après un redémarrage !

Iot speaker

2019-06-19T13:44:09Z

Tala : /* Enceinte armbian */

=Projet=
{|class="wikitable" width="100%"
|-valign=top
! Objectif !! Les acteurs !! Compétences !! Matériel
|-valign=top
||
Construire des enceintes sans-fils (sauf le courant) actives connectées capables de travailler en "groupe"
||
*[[User:Tala | Tala]]
*[[User:Nigdor |Nigdor]]
*[[User:Prandar |Prandar]]
||
*électronique
*C++ (microcontrôleur)
||
* microcontrôleur (esp8266)
* amplificateur audio (XPT8871, PAM8403, ...)
* décodeur MP3 (VS1053B)
* potentiomètre digital (X9C103S)
|}

= Choix de l'amplificateur =
A faire:
*Expliquer la différence entre classe AB et D (qualité sonore vs. éco énergie)
*Faire un tableau récapitulatif des caractéristiques des amplis:
** mono / stéréo / les deux
** tension de fonctionnement / consommation (5v, 12v, 24v, etc...)
** puissance (5w, 20w, 30w, etc...)
** impédance de sortie (2 x 4Ω, 1 x 8Ω, etc...)
** réponse fréquentielle ;
** résistance aux courts-circuits ;
** bruit pop (quand pas de musique);
** besoin d'un dissipateur ou non (effet joule à prévoir...)
** lien vers la documentation si besoin d'info(eg. pour le [https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932])
** le plus important : le ressenti !
==Classe AB==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
TDA7297
|align=center|
[[Fichier:TDA7297.png|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 15W
|align=center|
2A (peak)
|align=center|
6 - 18 V
|align=center|
OUI
|align=center|
Avec µControlleur<br>(p. 3/4)
|align=center|
Obligatoire
|align=center|
[http://www.st.com/content/ccc/resource/technical/document/datasheet/a3/eb/9b/59/dd/26/4a/27/CD00001048.pdf/files/CD00001048.pdf/jcr:content/translations/en.CD00001048.pdf TDA7297]
|align=left|
Super amplification sans distorsion !
<br>
Forte dissipation thermique à pleine puissance :
* 33W d'après la doc;
* vraiment très (trop) fort !
|}
</div>

==Classe D==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
XH-M531 (YDA138)
|align=center|
[[Fichier:XH-M531.jpg|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 10 W<br>
2 x 20 W
|align=center|
8 Ω<br>
4 Ω
|align=center|
12 - 15V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.ksp-electronics.com/product_files/8eeedc66ea8fbcdf2e74294037c2f389 YDA138]
|align=center|
|-valign="top"
|align=center|
PAM8403
|align=center|
[[Fichier:PAM8403.jpg|centré|100px]]
|align=center|
Stéréo
|align=center|
3W(*2 ?)
|align=center|
4 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
Reduit mais présent
|align=center|
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8403.pdf PAM8403]
|align=center|
|-valign="top"
|align=center|
PAM8610
|align=center|
[[Fichier:PAM8610.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 10 W
|align=center|
8 Ω
|align=center|
7 - 15 V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8610.pdf PAM8610]
|align=center|
|-valign="top"
|align=center|
XPT8871
|align=center|
[[Fichier:XPT8871.jpg|centré|120px]]
|align=center|
Mono
|align=center|
3.5w
<br>
5w
|align=center|
3 Ω
<br>
2 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[[Media:XPT8871.pdf|XPT8871]]
|align=left|
*Bien pour la voix, pas top pour la musique
|-valign="top"
|align=center|
TDA8932
|align=center|
[[Fichier:TDA8932.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2*15W
|align=center|
4 Ω
|align=center|
Entre 10 V et 36 V (Rechercher quel est le plus optimal)
|align=center|
OUI
|align=center|
NON
|align=center|

|align=center|
[https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932]
|align=center|
|-valign="top"
|align=center|
TPA3110
|align=center|
[[Fichier:TPA3110.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
15W/ch
|align=center|
8 Ω
|align=center|
16 V
|align=center|
OUI
|align=center|
NON
|align=center|
OUI
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3110d2.pdf TPA3110]
|align=left|
*Amplification moyenne
*Basses creuses
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3116
|align=center|
[[Fichier:TPA3116.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 50W<br>
2 x 15W
|align=center|
4 Ω<br>
8 Ω
|align=center|
21 V<br>
15 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI<br>
NON
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3116d2.pdf TPA3116]
|align=left|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3118
|align=center|
[[Fichier:TPA3118.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 30W
|align=center|
8 Ω
|align=center|
12 - 24 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI
|align=left|
[http://www.ti.com/lit/ds/symlink/tpa3118d2.pdf TPA3118]
|align=center|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|}
</div>

= Potentiomètre digital =
A faire

= Décodeur MP3 =
==Présentation==
Le décodeur MP3 choisi est le VS1053

[[Fichier:vs1053_board.jpg|centré|200px]]

Ce décodeur offre une interface SPI et permet de lire ainsi que d'enregistrer des fichiers aux formats :
* lecture :
**MP3 ;
**Ogg Vorbis (libre de droit) ;
**PCM;
**WAV;
* enregistrement :
**Ogg Vorbis(libre de droit) ;

==Documentation technique==
Voici la [[:Media:vs1053_doc.pdf|documentation du VS1053]], pour ceux qui voudraient écrire une librairie C++ !

== Schéma ==
Les tests ont été réalisés avec un WemOS D1 mini (ESP8266) :
<div align="center">
{|class="wikitable" width="85%"
! ESP8266 !! VS1053 !! Connections
|-valign=top
||
[[Fichier:wemos_D1_R2_mini_diagram.png|centré|470px]]
||
[[Fichier:vs1053_board_diagram.png|centré|300px]]
|align="center"|
{|class="wikitable"
! ESP8266 !! VS1053
|-
|align="center"| D0
|align="center"| XDCS
|-
|align="center"| D1
|align="center"| XoS (Cable Select)
|-
|align="center"| D3
|align="center"| DREQ
|-
|align="center"| D5
|align="center"| SCK (Serial ClocK)
|-
|align="center"| D6
|align="center"| MISO (Master In Slave Out)
|-
|align="center"| D7
|align="center"| MOSI (Master Out Slave In)
|-
|align="center"| RST
|align="center"| XRST
|-
|align="center"| 5V
|align="center"| 5V
|-
|align="center"| G
|align="center"| DGND
|}
|}
</div>
Vous devriez avoir quelque chose comme ça :

[[Fichier:wemos_D1_vs1053_diagram.jpg|centré|400px]]

== Programmation ==
Tout d'abord un grand merci à [https://github.com/baldram/ESP_VS1053_Library ''baldram''] pour sa [[Media:ESP_VS1053_Library.zip|librairie]] que nous allons utiliser !

Le plus simple est de regarder l'exemple ''SimpleMP3Player'' fourni avec la librairie :
<source lang="c">
// La fameuse librairie de baldram
#include <VS1053.h>
// Un MP3 au format binaire dans un tableau (le fichier est livré avec la librairie)
#include <helloMp3.h>
// Définition des port SPI utilisé (ici pour l'ESP8266)
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
// Définition du volume
#define VOLUME 80 // volume level 0-100
// Création de l'objet VS1053
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);

void setup () {
// Démarrage du SPI
SPI.begin();
// démarrage du VS1053
player.begin();
// Ligne nécessaire pour certain lecteur
player.switchToMp3Mode();
player.setVolume(VOLUME);
}

void loop() {
// On joue le MP3 dans le tableau
player.playChunk(helloMp3, sizeof(helloMp3));
// On attend 3 secondes
delay(3000);
}
</source>
Pour que cet exemple fonctionne, il faut soit copier le contenu de ''HelloMp3.h'' dans le fichier exemple, soit copier le fichier dans le répertoire de la librairie dans votre dossier ''Arduino''.

Une fois la compilation terminée, vous devriez entendre ''du bruit'' sortir du VS1053 !

= Flux musical =
La communication se fera en générant un flux entre le programme (PC) et l'enceinte (ESP8266). Ce flux, pour des raisons de simplicité, se fera en TCP car ce protocole gère les retransmissions, les tampons d'entrée / sortie, etc...

A terme, une application temps réel comme la musique mériterait de passer sur de l'UDP. Surtout que, si l'on souhaite utiliser du [https://www.tala-informatique.fr/wiki/index.php/Esp8266_udp_server multicast], pour parler à un groupe d'enceintes, on ne peut le faire qu'en UDP !
== Envoi : serveur en PHP ==
La partie serveur prend un fichier, ici un MP3, lit un morceau du fichier et l'envoi à l'enceinte à travers une socket TCP. Deux paramètres sont à prendre en compte :
*le temps d'attente entre chaque envoi;
*la taille d'un morceau;
Ces paramètres nécessiteront certainement un temps d'ajustement qui sera en fonction de la latence, la congestion du réseau, les capacités des puces impliquées (ici l'ESP8266), etc...
{|style="width:650px" align="center"
|
[[Fichier:warning-icon.png|centré|60px]]
|valign="top" align="justify"|
Les extraits de code qui vont suivre respectent vaguement les préceptes, au combien importants, de la programmation orientée objet et sont fournis à titre indicatif dans l'unique but de démontrer la faisabilité d'un tel projet ! Voici [[:Media:Iot_Speaker.zip | l'archive]] qui contient le code exposé ci-dessous.
|}
=== MusicSender ===
Voici le contenu du fichier ''MusicSender.class.php'' :
<source lang="php">
<?php

class MusicSender
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5045;

// Le temps d'attente en microsecondes entre chaque paquets
private static $SLEEP_INTERVAL = 2500;

// La taille de chacun des paquets
private static $CHUNK_BUFFER = 32768;

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Envoie le MP3 à l'enceinte
*
* @param string $mp3File
* @return boolean
*/
public function play($mp3File)
{
if (is_file($mp3File)) {
// Ouverture du fichier en lecture binaire
$file = fopen($mp3File, 'rb');
if ($file === FALSE) {
echo "Fail reading file " . $file . "\n";
return FALSE;
}
// Ouverture de la socket
$socket = $this->openSocket();
// Tant qu'on est pas à la fin du fichier
while (! feof($file)) {
// Envoie d'un "morceau" de taille CHUNK_BUFFER à l'enceinte
if (@socket_write($this->socket, fread($file, self::$CHUNK_BUFFER), self::$CHUNK_BUFFER) === FALSE) {
// Problème de socket (fermeture, déconnexion, etc...)
return FALSE;
}
usleep(self::$SLEEP_INTERVAL);
}
// Fermeture de la socket
$this->closeSocket();
// Fermeture du fichier
fclose($file);
return TRUE;
}
echo $file." does not exists !\n";
return FALSE;
}

/**
* Lit tous les mp3 présents dans le dossier
*
* @param string $dir
*/
public function readFolder($dir)
{
if (is_dir($dir)) {
// On récupére les fichiers sans les 2 premiers '.' et '..'
$files = array_slice(scandir($dir), 2);
foreach ($files as $file) {
// On créé le chemin absolu
$mp3File = $dir . DIRECTORY_SEPARATOR . $file;
// On test l'extension
if (pathinfo($file)["extension"] == "mp3") {
$this->play($mp3File);
}
}
return true;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) == FALSE) {
echo "socket_create_listen() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
if (socket_connect($this->socket, $this->ip, self::$PORT) == FALSE) {
echo "socket_bind() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
=== Launch.php ===
On créé un fichier ''Launch.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicSender.class.php';

$esp_ip = "192.168.1.200";

$dir = "!!chemin_vers_des_fichiers_mp3!!";

$sender = new MusicSender($esp_ip);

$sender->readFolder($dir);
</source>

== Réception : ESP8266 ==
{|style="width:650px" align="center"
|
[[Fichier:Warning manual.jpg|centré|300px]]
|valign="top" align="justify"|
Soyez sûr de comprendre la section sur [https://www.tala-informatique.fr/wiki/index.php/Arduino_sketch_writing| comment écrire un sketch] avant de poursuivre. Le code ci-dessous fait référence à des parties bien spécifiques, détaillées et expliquées dans la section suscitée.
|}
=== Partie WiFi ===
La première étape consiste à raccorder notre ''ESP'' au réseau WiFi !
<source lang="c">
#include <ESP8266WiFi.h>
#include <WiFiClient.h>

// WiFi Parameters //
const char ssid[] = "cfcasa";
const char password[] = "***********";
IPAddress ip(192, 168, 1, 200);
IPAddress gw(192, 168, 1, 254);
IPAddress mask(255, 255, 252, 0);

void setup() {
// on démarre le port série
Serial.begin(115200);
// On attend "un peu" que le buffer soit prêt
delay(10);
// On démarre le WiFi
initWiFi();
}

void loop() {
}

void initWiFi() {
// On efface la configuration précédente
WiFi.disconnect(true);
Serial.printf("\nConnexion a %s", ssid);
// Initialisation de la connection
WiFi.config(ip, gw, mask, gw);
WiFi.begin(ssid, password);
// Test pour déterminer quand la connection est prete
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(".");
}
// Affichage des informations
Serial.printf(" connecté\nAdresse IP: %s\n", WiFi.localIP().toString().c_str());
}
</source>
=== Lecteur MP3 ===
Vient ensuite la partie du lecteur MP3. Dans la partie des imports, ajoutez la ligne suivante :
<source lang="c">
#include <VS1053.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Parameters //
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
#define VOLUME 70 // volume level 0-100
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);
uint8_t volume_level = VOLUME;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le shield MP3
initMP3();
</source>
A la suite, on insère la fonction suivante :
<source lang="c">
void initMP3() {
SPI.begin();
// Démarrage du lecteur MP3
player.begin();
player.switchToMp3Mode();
player.setVolume(volume_level);
}
</source>
=== Récupération du stream MP3 ===
On va maintenant récupérer le flux envoyé depuis le serveur. Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Server parameters //
const uint16_t MP3_PORT = 5045;
WiFiServer server(MP3_PORT);
const uint16_t BUFFER_SIZE = 16384;
//const uint16_t BUFFER_SIZE = 32768;
byte buffer[BUFFER_SIZE + 1];
uint16_t byteRead = 0;
bool isBufferReady = false;
WiFiClient client;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur TCP
initMp3Server();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
void initMp3Server() {
// Démarrage du serveur TCP
server.begin();
Serial.printf("Ecoute TCP sur le port %d\n", MP3_PORT);
}

void readMp3() {
// Un client est connecté
if (client) {
// Si le client est toujours connecté...
if (client.connected()) {
// Tant que l'on reçoit de la musique
while (client.available() > 0) {
// On rempli le buffer avec le contenu du paquet TCP
buffer[byteRead++] = client.read();
// Si le buffer est plein
if (byteRead == BUFFER_SIZE) {
// On previent que le buffer est plein
isBufferReady = true;
// On sort de la boucle
break;
}
}
// Si le buffer est plein
if (isBufferReady) {
// On envoi tout au lecteur MP3
player.playChunk(buffer, byteRead);
// On RAZ le compteur de bytes
byteRead = 0;
}
} else {
// Si le client est déconneté
client = server.available();
// On prévient que le buffer est vide
isBufferReady = false;
// On RAZ le compteur de bytes
byteRead = 0;
Serial.println(F("Client disconnected"));
}
} else {
// On test la présence d'un client
client = server.available();
if (client) {
// Un client est connecté !
Serial.println(F("New client !"));
}
}
}
</source>
Enfin, on ajoute le ligne suivante dans la fonction ''loop()'' :
<source lang="c">
readMp3();
</source>
A ce stade, l'ESP devrait être capable de récupérer le flux et de le jouer !

= Envoi de commandes =
Envoyer de la musique c'est bien, pouvoir régler le volume c'est encore mieux !

La façon la plus simple d'adresser le problème c'est d'utiliser un autre port et, comme les messages sont petits, d'utiliser UDP.
== Partie Serveur ==
Dans la même veine, voici la classe qui permet d'envoyer les commandes :
<source lang="php">
<?php

class MusicHandler
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5046;

// Le port de l'enceinte connectée
private static $RETRIES = 3;

// Liste de commandes
private static $CMD_VOLUME = 'V';

private static $CMD_LOCATE = 'L';

private static $CMD_RESET = 'R';

private static $RESPONSE_NOK = 'N';

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Augmente le volume d'un incrément
*
* @return boolean
*/
public function volumeUp()
{
return $this->sendCommand(self::$CMD_VOLUME . "+");
}

/**
* Baisse le volume d'un incrément
*
* @return boolean
*/
public function volumeDown()
{
return $this->sendCommand(self::$CMD_VOLUME . "-");
}

/**
*
* @return boolean
*/
public function setVolume($volume)
{
if ($volume < 0 || $volume > 100) {
return false;
}
return $this->sendCommand(self::$CMD_VOLUME . $volume);
}

public function getVolume(){
return $this->sendCommand(self::$CMD_VOLUME);
}

/**
*
* @return boolean
*/
public function doReset()
{
return $this->sendCommand(self::$CMD_RESET);
}

public function doLocate(){
return $this->sendCommand(self::$CMD_LOCATE);
}

/**
* Envoie une commande au module
*
* @param string $message
*/
private function sendCommand($message)
{
$result = false;
if ($this->openSocket() !== FALSE) {
if (socket_sendto($this->socket, $message, strlen($message), 0, $this->ip, self::$PORT) !== FALSE) {
$result = $this->readAcknoledge();
}
}
$this->closeSocket();
return $result;
}

/**
* Attend la confirmation de la commande
*
* @return boolean
*/
private function readAcknoledge()
{
$buf = "";
$retries = 0;
while ($retries < self::$RETRIES) {
$byteReceived = socket_recvfrom($this->socket, $buf, 2048, 0, $this->ip, self::$PORT);
if ($byteReceived > 0) {
return $buf != self::$RESPONSE_NOK ? $buf : FALSE;
}
usleep(500000);
$retries ++;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) === FALSE) {
$errorcode = socket_last_error();
$errormsg = socket_strerror($errorcode);
echo ("Couldn't create socket: [$errorcode] $errormsg \n");
return false;
}
return true;
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
On créé un fichier ''Command.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicHandler.class.php';

$esp_ip = "192.168.1.200";

$handler = new MusicHandler($esp_ip);

// Exemple de commandes //
//$result = $handler->volumeUp();
//$result = $handler->getVolume();
//$result = $handler->doReset();
//$result = $handler->setVolume(70);

$result = $handler->doLocate();

echo $result !== FALSE ? "ok : $result\n" : "nok\n";
</source>
== Partie Cliente ==
Dans la partie des imports ajoutez la ligne suivante :
<source lang="c">
#include <WiFiUDP.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// Command Server parameters //
const uint16_t CMD_PORT = 5046;
// L'instance du serveur UDP
WiFiUDP udp;
// Liste de commandes
const char CMD_VOLUME = 'V';
const char CMD_LOCATE = 'L';
const char CMD_RESET = 'R';
const char RESPONSE_NOK[] = "N";

// Localisation parameters
uint8_t ledPin = LED_BUILTIN;
const uint16_t BLINK_FREQ = 500;
const uint8_t BLINK_REP = 60;
uint8_t repetition = 0;
uint32_t timer;
bool isLocate = false;
</source>
A la fin de la fonction setup() nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur UDP
initCmdServer();
// On prépare la led de localisation
initLocateLed();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
bool readCmd() {
if (udp.parsePacket() > 0) {
uint8_t len = udp.available();
char c = udp.read();
if (len == 1) {
if (c == CMD_RESET) {
player.softReset();
sendPacket(CMD_RESET);
return true;
} else if (c == CMD_VOLUME) {
sendPacket(volume_level);
return true;
} else if (c == CMD_LOCATE) {
if (!isLocate) {
locate(true);
sendPacket(CMD_LOCATE);
return true;
}
}
} else if (len == 2) {
char value = udp.read();
if (c == CMD_VOLUME) {
if (value == '+' && volume_level != 100) {
setVolume(volume_level + 1);
} else if (value == '-' && volume_level != 0) {
setVolume(volume_level - 1);
} else {
sendNack();
return false;
}
return true;
}
} else {
if (c == CMD_VOLUME) {
char value[4] = "0";
udp.read(value, 3);
uint8_t vol = atoi(value);
if (vol >= 0 && vol <= 100) {
setVolume(vol);
return true;
}
}
}
sendNack();
return false;
}
// Check if locate needs to be done
locate(false);
}
void locate(bool blink) {
if (blink) {
// Initialisation des variables
digitalWrite(ledPin, LOW);
isLocate = true;
repetition = 0;
timer = millis();
} else if (isLocate) {
// Calcule du temps
uint32_t elapsed = millis() - timer;
if (elapsed > BLINK_FREQ) {
repetition++;
if (repetition == BLINK_REP) {
// On a atteint le nombre de clignotements
isLocate = false;
digitalWrite(ledPin, HIGH);
} else {
// On fait clignoter la led
digitalWrite(ledPin, !digitalRead(ledPin));
timer = millis();
}
}
}
}

void setVolume(uint8_t vol) {
volume_level = vol;
Serial.printf("Setting volume to %d\n", volume_level);
player.setVolume(volume_level);
sendPacket(volume_level);
}

void sendNack() {
sendPacket(RESPONSE_NOK);
}

void sendPacket(const char content) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(const char content[]) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(int content) {
char value[4];
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(itoa(content, value, 10));
udp.endPacket();
}

void initCmdServer() {
// Démarrage du serveur TCP
udp.begin(CMD_PORT);
Serial.printf("Ecoute UDP sur le port %d\n", CMD_PORT);
}

void initLocateLed() {
pinMode(ledPin, OUTPUT);
digitalWrite(ledPin, HIGH);
}
</source>
L'ESP est maintenant capable de :
* monter / baisser le volume ;
* de faire un reset du lecteur MP3 (en cas de problème)
* de faire clignoter sa led pour être localisé facilement.

= Enceinte armbian =
Même objectif mais cette fois-ci avec Rygel, un lecteur DLNA.
==Installation ==
Le système:
<pre>
# apt-get update
</pre>
Le lecteur rygel:
<pre>
# apt-get -y install rygel-playbin
</pre>
Les différents plugins. Tout d'abord, récupérer les plugins en fonctions de la distribution:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | awk -F ' - ' '{print $1}')
# apt-get install ${plugins}
</pre>
Ensuite on procéde à l'installation:
<pre>
# apt-get install ${plugins}
</pre>
== Création du fichier de service ==
Il suffit de créer le fichier ''/etc/systemd/system/rygel.service'':
<pre>
[Unit]
Description=Rygel service
After=network-online.target

[Service]
Type=simple
UMask=007
ExecStart=/usr/bin/rygel -g 5
Restart=on-failure

# Configures the time to wait before service is stopped forcefully.
TimeoutStopSec=300

[Install]
WantedBy=multi-user.target
</pre>
On peut lancer le service et l'activer au démarrage
<pre>
# systemctl start rygel
# systemctl enable rygel
</pre>
== Désactivation des logs ==
Comme l'enceinte n'est pas à proprement parler un serveur exécutant un service critique, on peut désactiver le système de logging pour économiser la durée de vie de la carte SD:
<pre>
# systemctl stop rsyslog
# systemctl disable rsyslog
</pre>
== Ajustement du volume ==
Il faut maintenant mettre le volume au maximum coté Pi avec le mixer ALSA [https://fr.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture wikipedia] :
<pre>
# alsamixer
</pre>
[[Fichier:alsamixer armbian.png|centré]]

Fichier:Alsamixer armbian.png

2019-06-19T13:35:49Z

Tala :

Iot speaker

2019-06-19T13:01:56Z

Tala :

=Projet=
{|class="wikitable" width="100%"
|-valign=top
! Objectif !! Les acteurs !! Compétences !! Matériel
|-valign=top
||
Construire des enceintes sans-fils (sauf le courant) actives connectées capables de travailler en "groupe"
||
*[[User:Tala | Tala]]
*[[User:Nigdor |Nigdor]]
*[[User:Prandar |Prandar]]
||
*électronique
*C++ (microcontrôleur)
||
* microcontrôleur (esp8266)
* amplificateur audio (XPT8871, PAM8403, ...)
* décodeur MP3 (VS1053B)
* potentiomètre digital (X9C103S)
|}

= Choix de l'amplificateur =
A faire:
*Expliquer la différence entre classe AB et D (qualité sonore vs. éco énergie)
*Faire un tableau récapitulatif des caractéristiques des amplis:
** mono / stéréo / les deux
** tension de fonctionnement / consommation (5v, 12v, 24v, etc...)
** puissance (5w, 20w, 30w, etc...)
** impédance de sortie (2 x 4Ω, 1 x 8Ω, etc...)
** réponse fréquentielle ;
** résistance aux courts-circuits ;
** bruit pop (quand pas de musique);
** besoin d'un dissipateur ou non (effet joule à prévoir...)
** lien vers la documentation si besoin d'info(eg. pour le [https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932])
** le plus important : le ressenti !
==Classe AB==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
TDA7297
|align=center|
[[Fichier:TDA7297.png|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 15W
|align=center|
2A (peak)
|align=center|
6 - 18 V
|align=center|
OUI
|align=center|
Avec µControlleur<br>(p. 3/4)
|align=center|
Obligatoire
|align=center|
[http://www.st.com/content/ccc/resource/technical/document/datasheet/a3/eb/9b/59/dd/26/4a/27/CD00001048.pdf/files/CD00001048.pdf/jcr:content/translations/en.CD00001048.pdf TDA7297]
|align=left|
Super amplification sans distorsion !
<br>
Forte dissipation thermique à pleine puissance :
* 33W d'après la doc;
* vraiment très (trop) fort !
|}
</div>

==Classe D==
<div align="center">
{|class="wikitable" width="85%"
! Modèle !! Image !! Phonique !! Puissance !! Impédance !! Tension !! PCC !! POP !! Dissipateur !! Documentation !! Avis
|-valign="top"
|align=center|
XH-M531 (YDA138)
|align=center|
[[Fichier:XH-M531.jpg|centré|200px]]
|align=center|
Stéréo
|align=center|
2 x 10 W<br>
2 x 20 W
|align=center|
8 Ω<br>
4 Ω
|align=center|
12 - 15V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.ksp-electronics.com/product_files/8eeedc66ea8fbcdf2e74294037c2f389 YDA138]
|align=center|
|-valign="top"
|align=center|
PAM8403
|align=center|
[[Fichier:PAM8403.jpg|centré|100px]]
|align=center|
Stéréo
|align=center|
3W(*2 ?)
|align=center|
4 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
Reduit mais présent
|align=center|
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8403.pdf PAM8403]
|align=center|
|-valign="top"
|align=center|
PAM8610
|align=center|
[[Fichier:PAM8610.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 10 W
|align=center|
8 Ω
|align=center|
7 - 15 V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[https://www.diodes.com/assets/Datasheets/PAM8610.pdf PAM8610]
|align=center|
|-valign="top"
|align=center|
XPT8871
|align=center|
[[Fichier:XPT8871.jpg|centré|120px]]
|align=center|
Mono
|align=center|
3.5w
<br>
5w
|align=center|
3 Ω
<br>
2 Ω
|align=center|
5V
|align=center|
OUI
|align=center|
OUI
|align=center|
NON
|align=center|
[[Media:XPT8871.pdf|XPT8871]]
|align=left|
*Bien pour la voix, pas top pour la musique
|-valign="top"
|align=center|
TDA8932
|align=center|
[[Fichier:TDA8932.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
2*15W
|align=center|
4 Ω
|align=center|
Entre 10 V et 36 V (Rechercher quel est le plus optimal)
|align=center|
OUI
|align=center|
NON
|align=center|

|align=center|
[https://www.nxp.com/docs/en/data-sheet/TDA8932B.pdf TDA8932]
|align=center|
|-valign="top"
|align=center|
TPA3110
|align=center|
[[Fichier:TPA3110.jpg|centré|150px]]
|align=center|
Stéréo
|align=center|
15W/ch
|align=center|
8 Ω
|align=center|
16 V
|align=center|
OUI
|align=center|
NON
|align=center|
OUI
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3110d2.pdf TPA3110]
|align=left|
*Amplification moyenne
*Basses creuses
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3116
|align=center|
[[Fichier:TPA3116.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 50W<br>
2 x 15W
|align=center|
4 Ω<br>
8 Ω
|align=center|
21 V<br>
15 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI<br>
NON
|align=center|
[http://www.ti.com/lit/ds/symlink/tpa3116d2.pdf TPA3116]
|align=left|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|-valign="top"
|align=center|
TPA3118
|align=center|
[[Fichier:TPA3118.png|centré|150px]]
|align=center|
Stéréo
|align=center|
2 x 30W
|align=center|
8 Ω
|align=center|
12 - 24 V
|align=center|
OUI
|align=center|
OUI par µC
|align=center|
OUI
|align=left|
[http://www.ti.com/lit/ds/symlink/tpa3118d2.pdf TPA3118]
|align=center|
*Bonne amplification
*Basses profondes
*Distorsions peu audibles
|}
</div>

= Potentiomètre digital =
A faire

= Décodeur MP3 =
==Présentation==
Le décodeur MP3 choisi est le VS1053

[[Fichier:vs1053_board.jpg|centré|200px]]

Ce décodeur offre une interface SPI et permet de lire ainsi que d'enregistrer des fichiers aux formats :
* lecture :
**MP3 ;
**Ogg Vorbis (libre de droit) ;
**PCM;
**WAV;
* enregistrement :
**Ogg Vorbis(libre de droit) ;

==Documentation technique==
Voici la [[:Media:vs1053_doc.pdf|documentation du VS1053]], pour ceux qui voudraient écrire une librairie C++ !

== Schéma ==
Les tests ont été réalisés avec un WemOS D1 mini (ESP8266) :
<div align="center">
{|class="wikitable" width="85%"
! ESP8266 !! VS1053 !! Connections
|-valign=top
||
[[Fichier:wemos_D1_R2_mini_diagram.png|centré|470px]]
||
[[Fichier:vs1053_board_diagram.png|centré|300px]]
|align="center"|
{|class="wikitable"
! ESP8266 !! VS1053
|-
|align="center"| D0
|align="center"| XDCS
|-
|align="center"| D1
|align="center"| XoS (Cable Select)
|-
|align="center"| D3
|align="center"| DREQ
|-
|align="center"| D5
|align="center"| SCK (Serial ClocK)
|-
|align="center"| D6
|align="center"| MISO (Master In Slave Out)
|-
|align="center"| D7
|align="center"| MOSI (Master Out Slave In)
|-
|align="center"| RST
|align="center"| XRST
|-
|align="center"| 5V
|align="center"| 5V
|-
|align="center"| G
|align="center"| DGND
|}
|}
</div>
Vous devriez avoir quelque chose comme ça :

[[Fichier:wemos_D1_vs1053_diagram.jpg|centré|400px]]

== Programmation ==
Tout d'abord un grand merci à [https://github.com/baldram/ESP_VS1053_Library ''baldram''] pour sa [[Media:ESP_VS1053_Library.zip|librairie]] que nous allons utiliser !

Le plus simple est de regarder l'exemple ''SimpleMP3Player'' fourni avec la librairie :
<source lang="c">
// La fameuse librairie de baldram
#include <VS1053.h>
// Un MP3 au format binaire dans un tableau (le fichier est livré avec la librairie)
#include <helloMp3.h>
// Définition des port SPI utilisé (ici pour l'ESP8266)
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
// Définition du volume
#define VOLUME 80 // volume level 0-100
// Création de l'objet VS1053
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);

void setup () {
// Démarrage du SPI
SPI.begin();
// démarrage du VS1053
player.begin();
// Ligne nécessaire pour certain lecteur
player.switchToMp3Mode();
player.setVolume(VOLUME);
}

void loop() {
// On joue le MP3 dans le tableau
player.playChunk(helloMp3, sizeof(helloMp3));
// On attend 3 secondes
delay(3000);
}
</source>
Pour que cet exemple fonctionne, il faut soit copier le contenu de ''HelloMp3.h'' dans le fichier exemple, soit copier le fichier dans le répertoire de la librairie dans votre dossier ''Arduino''.

Une fois la compilation terminée, vous devriez entendre ''du bruit'' sortir du VS1053 !

= Flux musical =
La communication se fera en générant un flux entre le programme (PC) et l'enceinte (ESP8266). Ce flux, pour des raisons de simplicité, se fera en TCP car ce protocole gère les retransmissions, les tampons d'entrée / sortie, etc...

A terme, une application temps réel comme la musique mériterait de passer sur de l'UDP. Surtout que, si l'on souhaite utiliser du [https://www.tala-informatique.fr/wiki/index.php/Esp8266_udp_server multicast], pour parler à un groupe d'enceintes, on ne peut le faire qu'en UDP !
== Envoi : serveur en PHP ==
La partie serveur prend un fichier, ici un MP3, lit un morceau du fichier et l'envoi à l'enceinte à travers une socket TCP. Deux paramètres sont à prendre en compte :
*le temps d'attente entre chaque envoi;
*la taille d'un morceau;
Ces paramètres nécessiteront certainement un temps d'ajustement qui sera en fonction de la latence, la congestion du réseau, les capacités des puces impliquées (ici l'ESP8266), etc...
{|style="width:650px" align="center"
|
[[Fichier:warning-icon.png|centré|60px]]
|valign="top" align="justify"|
Les extraits de code qui vont suivre respectent vaguement les préceptes, au combien importants, de la programmation orientée objet et sont fournis à titre indicatif dans l'unique but de démontrer la faisabilité d'un tel projet ! Voici [[:Media:Iot_Speaker.zip | l'archive]] qui contient le code exposé ci-dessous.
|}
=== MusicSender ===
Voici le contenu du fichier ''MusicSender.class.php'' :
<source lang="php">
<?php

class MusicSender
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5045;

// Le temps d'attente en microsecondes entre chaque paquets
private static $SLEEP_INTERVAL = 2500;

// La taille de chacun des paquets
private static $CHUNK_BUFFER = 32768;

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Envoie le MP3 à l'enceinte
*
* @param string $mp3File
* @return boolean
*/
public function play($mp3File)
{
if (is_file($mp3File)) {
// Ouverture du fichier en lecture binaire
$file = fopen($mp3File, 'rb');
if ($file === FALSE) {
echo "Fail reading file " . $file . "\n";
return FALSE;
}
// Ouverture de la socket
$socket = $this->openSocket();
// Tant qu'on est pas à la fin du fichier
while (! feof($file)) {
// Envoie d'un "morceau" de taille CHUNK_BUFFER à l'enceinte
if (@socket_write($this->socket, fread($file, self::$CHUNK_BUFFER), self::$CHUNK_BUFFER) === FALSE) {
// Problème de socket (fermeture, déconnexion, etc...)
return FALSE;
}
usleep(self::$SLEEP_INTERVAL);
}
// Fermeture de la socket
$this->closeSocket();
// Fermeture du fichier
fclose($file);
return TRUE;
}
echo $file." does not exists !\n";
return FALSE;
}

/**
* Lit tous les mp3 présents dans le dossier
*
* @param string $dir
*/
public function readFolder($dir)
{
if (is_dir($dir)) {
// On récupére les fichiers sans les 2 premiers '.' et '..'
$files = array_slice(scandir($dir), 2);
foreach ($files as $file) {
// On créé le chemin absolu
$mp3File = $dir . DIRECTORY_SEPARATOR . $file;
// On test l'extension
if (pathinfo($file)["extension"] == "mp3") {
$this->play($mp3File);
}
}
return true;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) == FALSE) {
echo "socket_create_listen() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
if (socket_connect($this->socket, $this->ip, self::$PORT) == FALSE) {
echo "socket_bind() a échoué : " . socket_strerror(socket_last_error($this->socket)) . "\n";
return false;
}
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
=== Launch.php ===
On créé un fichier ''Launch.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicSender.class.php';

$esp_ip = "192.168.1.200";

$dir = "!!chemin_vers_des_fichiers_mp3!!";

$sender = new MusicSender($esp_ip);

$sender->readFolder($dir);
</source>

== Réception : ESP8266 ==
{|style="width:650px" align="center"
|
[[Fichier:Warning manual.jpg|centré|300px]]
|valign="top" align="justify"|
Soyez sûr de comprendre la section sur [https://www.tala-informatique.fr/wiki/index.php/Arduino_sketch_writing| comment écrire un sketch] avant de poursuivre. Le code ci-dessous fait référence à des parties bien spécifiques, détaillées et expliquées dans la section suscitée.
|}
=== Partie WiFi ===
La première étape consiste à raccorder notre ''ESP'' au réseau WiFi !
<source lang="c">
#include <ESP8266WiFi.h>
#include <WiFiClient.h>

// WiFi Parameters //
const char ssid[] = "cfcasa";
const char password[] = "***********";
IPAddress ip(192, 168, 1, 200);
IPAddress gw(192, 168, 1, 254);
IPAddress mask(255, 255, 252, 0);

void setup() {
// on démarre le port série
Serial.begin(115200);
// On attend "un peu" que le buffer soit prêt
delay(10);
// On démarre le WiFi
initWiFi();
}

void loop() {
}

void initWiFi() {
// On efface la configuration précédente
WiFi.disconnect(true);
Serial.printf("\nConnexion a %s", ssid);
// Initialisation de la connection
WiFi.config(ip, gw, mask, gw);
WiFi.begin(ssid, password);
// Test pour déterminer quand la connection est prete
while (WiFi.status() != WL_CONNECTED) {
delay(500);
Serial.print(".");
}
// Affichage des informations
Serial.printf(" connecté\nAdresse IP: %s\n", WiFi.localIP().toString().c_str());
}
</source>
=== Lecteur MP3 ===
Vient ensuite la partie du lecteur MP3. Dans la partie des imports, ajoutez la ligne suivante :
<source lang="c">
#include <VS1053.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Parameters //
#define VS1053_CS D1
#define VS1053_DCS D0
#define VS1053_DREQ D3
#define VOLUME 70 // volume level 0-100
VS1053 player(VS1053_CS, VS1053_DCS, VS1053_DREQ);
uint8_t volume_level = VOLUME;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le shield MP3
initMP3();
</source>
A la suite, on insère la fonction suivante :
<source lang="c">
void initMP3() {
SPI.begin();
// Démarrage du lecteur MP3
player.begin();
player.switchToMp3Mode();
player.setVolume(volume_level);
}
</source>
=== Récupération du stream MP3 ===
On va maintenant récupérer le flux envoyé depuis le serveur. Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// MP3 Server parameters //
const uint16_t MP3_PORT = 5045;
WiFiServer server(MP3_PORT);
const uint16_t BUFFER_SIZE = 16384;
//const uint16_t BUFFER_SIZE = 32768;
byte buffer[BUFFER_SIZE + 1];
uint16_t byteRead = 0;
bool isBufferReady = false;
WiFiClient client;
</source>
A la fin de la fonction ''setup()'' nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur TCP
initMp3Server();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
void initMp3Server() {
// Démarrage du serveur TCP
server.begin();
Serial.printf("Ecoute TCP sur le port %d\n", MP3_PORT);
}

void readMp3() {
// Un client est connecté
if (client) {
// Si le client est toujours connecté...
if (client.connected()) {
// Tant que l'on reçoit de la musique
while (client.available() > 0) {
// On rempli le buffer avec le contenu du paquet TCP
buffer[byteRead++] = client.read();
// Si le buffer est plein
if (byteRead == BUFFER_SIZE) {
// On previent que le buffer est plein
isBufferReady = true;
// On sort de la boucle
break;
}
}
// Si le buffer est plein
if (isBufferReady) {
// On envoi tout au lecteur MP3
player.playChunk(buffer, byteRead);
// On RAZ le compteur de bytes
byteRead = 0;
}
} else {
// Si le client est déconneté
client = server.available();
// On prévient que le buffer est vide
isBufferReady = false;
// On RAZ le compteur de bytes
byteRead = 0;
Serial.println(F("Client disconnected"));
}
} else {
// On test la présence d'un client
client = server.available();
if (client) {
// Un client est connecté !
Serial.println(F("New client !"));
}
}
}
</source>
Enfin, on ajoute le ligne suivante dans la fonction ''loop()'' :
<source lang="c">
readMp3();
</source>
A ce stade, l'ESP devrait être capable de récupérer le flux et de le jouer !

= Envoi de commandes =
Envoyer de la musique c'est bien, pouvoir régler le volume c'est encore mieux !

La façon la plus simple d'adresser le problème c'est d'utiliser un autre port et, comme les messages sont petits, d'utiliser UDP.
== Partie Serveur ==
Dans la même veine, voici la classe qui permet d'envoyer les commandes :
<source lang="php">
<?php

class MusicHandler
{

// L'adresse IP de l'enceinte connectée
private $ip;

// La socket utilisée pour communiquer avec l'enceinte
private $socket;

// Le port de l'enceinte connectée
private static $PORT = 5046;

// Le port de l'enceinte connectée
private static $RETRIES = 3;

// Liste de commandes
private static $CMD_VOLUME = 'V';

private static $CMD_LOCATE = 'L';

private static $CMD_RESET = 'R';

private static $RESPONSE_NOK = 'N';

public function __construct($ip)
{
$this->ip = $ip;
}

/**
* Augmente le volume d'un incrément
*
* @return boolean
*/
public function volumeUp()
{
return $this->sendCommand(self::$CMD_VOLUME . "+");
}

/**
* Baisse le volume d'un incrément
*
* @return boolean
*/
public function volumeDown()
{
return $this->sendCommand(self::$CMD_VOLUME . "-");
}

/**
*
* @return boolean
*/
public function setVolume($volume)
{
if ($volume < 0 || $volume > 100) {
return false;
}
return $this->sendCommand(self::$CMD_VOLUME . $volume);
}

public function getVolume(){
return $this->sendCommand(self::$CMD_VOLUME);
}

/**
*
* @return boolean
*/
public function doReset()
{
return $this->sendCommand(self::$CMD_RESET);
}

public function doLocate(){
return $this->sendCommand(self::$CMD_LOCATE);
}

/**
* Envoie une commande au module
*
* @param string $message
*/
private function sendCommand($message)
{
$result = false;
if ($this->openSocket() !== FALSE) {
if (socket_sendto($this->socket, $message, strlen($message), 0, $this->ip, self::$PORT) !== FALSE) {
$result = $this->readAcknoledge();
}
}
$this->closeSocket();
return $result;
}

/**
* Attend la confirmation de la commande
*
* @return boolean
*/
private function readAcknoledge()
{
$buf = "";
$retries = 0;
while ($retries < self::$RETRIES) {
$byteReceived = socket_recvfrom($this->socket, $buf, 2048, 0, $this->ip, self::$PORT);
if ($byteReceived > 0) {
return $buf != self::$RESPONSE_NOK ? $buf : FALSE;
}
usleep(500000);
$retries ++;
}
return false;
}

/**
* Ouverture de la socket
*/
private function openSocket()
{
if (($this->socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP)) === FALSE) {
$errorcode = socket_last_error();
$errormsg = socket_strerror($errorcode);
echo ("Couldn't create socket: [$errorcode] $errormsg \n");
return false;
}
return true;
}

/**
* Fermeture de la socket
*/
private function closeSocket()
{
socket_close($this->socket);
}
}
</source>
On créé un fichier ''Command.php'' qui va servir à appeler la classe précédente :
<source lang="php">
<?php
include 'MusicHandler.class.php';

$esp_ip = "192.168.1.200";

$handler = new MusicHandler($esp_ip);

// Exemple de commandes //
//$result = $handler->volumeUp();
//$result = $handler->getVolume();
//$result = $handler->doReset();
//$result = $handler->setVolume(70);

$result = $handler->doLocate();

echo $result !== FALSE ? "ok : $result\n" : "nok\n";
</source>
== Partie Cliente ==
Dans la partie des imports ajoutez la ligne suivante :
<source lang="c">
#include <WiFiUDP.h>
</source>
Dans la partie des variables statiques ajoutez les lignes suivantes :
<source lang="c">
// Command Server parameters //
const uint16_t CMD_PORT = 5046;
// L'instance du serveur UDP
WiFiUDP udp;
// Liste de commandes
const char CMD_VOLUME = 'V';
const char CMD_LOCATE = 'L';
const char CMD_RESET = 'R';
const char RESPONSE_NOK[] = "N";

// Localisation parameters
uint8_t ledPin = LED_BUILTIN;
const uint16_t BLINK_FREQ = 500;
const uint8_t BLINK_REP = 60;
uint8_t repetition = 0;
uint32_t timer;
bool isLocate = false;
</source>
A la fin de la fonction setup() nous allons ajouter les lignes suivantes :
<source lang="c">
// On démarre le serveur UDP
initCmdServer();
// On prépare la led de localisation
initLocateLed();
</source>
A la suite, on insère les fonctions suivantes :
<source lang="c">
bool readCmd() {
if (udp.parsePacket() > 0) {
uint8_t len = udp.available();
char c = udp.read();
if (len == 1) {
if (c == CMD_RESET) {
player.softReset();
sendPacket(CMD_RESET);
return true;
} else if (c == CMD_VOLUME) {
sendPacket(volume_level);
return true;
} else if (c == CMD_LOCATE) {
if (!isLocate) {
locate(true);
sendPacket(CMD_LOCATE);
return true;
}
}
} else if (len == 2) {
char value = udp.read();
if (c == CMD_VOLUME) {
if (value == '+' && volume_level != 100) {
setVolume(volume_level + 1);
} else if (value == '-' && volume_level != 0) {
setVolume(volume_level - 1);
} else {
sendNack();
return false;
}
return true;
}
} else {
if (c == CMD_VOLUME) {
char value[4] = "0";
udp.read(value, 3);
uint8_t vol = atoi(value);
if (vol >= 0 && vol <= 100) {
setVolume(vol);
return true;
}
}
}
sendNack();
return false;
}
// Check if locate needs to be done
locate(false);
}
void locate(bool blink) {
if (blink) {
// Initialisation des variables
digitalWrite(ledPin, LOW);
isLocate = true;
repetition = 0;
timer = millis();
} else if (isLocate) {
// Calcule du temps
uint32_t elapsed = millis() - timer;
if (elapsed > BLINK_FREQ) {
repetition++;
if (repetition == BLINK_REP) {
// On a atteint le nombre de clignotements
isLocate = false;
digitalWrite(ledPin, HIGH);
} else {
// On fait clignoter la led
digitalWrite(ledPin, !digitalRead(ledPin));
timer = millis();
}
}
}
}

void setVolume(uint8_t vol) {
volume_level = vol;
Serial.printf("Setting volume to %d\n", volume_level);
player.setVolume(volume_level);
sendPacket(volume_level);
}

void sendNack() {
sendPacket(RESPONSE_NOK);
}

void sendPacket(const char content) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(const char content[]) {
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(content);
udp.endPacket();
}

void sendPacket(int content) {
char value[4];
udp.beginPacket(udp.remoteIP(), udp.remotePort());
udp.write(itoa(content, value, 10));
udp.endPacket();
}

void initCmdServer() {
// Démarrage du serveur TCP
udp.begin(CMD_PORT);
Serial.printf("Ecoute UDP sur le port %d\n", CMD_PORT);
}

void initLocateLed() {
pinMode(ledPin, OUTPUT);
digitalWrite(ledPin, HIGH);
}
</source>
L'ESP est maintenant capable de :
* monter / baisser le volume ;
* de faire un reset du lecteur MP3 (en cas de problème)
* de faire clignoter sa led pour être localisé facilement.

= Enceinte armbian =
Même objectif mais cette fois-ci avec Rygel, un lecteur DLNA.
==Installation ==
Le système:
<pre>
# apt-get update
</pre>
Le lecteur rygel:
<pre>
# apt-get -y install rygel-playbin
</pre>
Les différents plugins. Tout d'abord, récupérer les plugins en fonctions de la distribution:
<pre>
# plugins=$(apt-cache search gstreamer | grep plugin | awk -F ' - ' '{print $1}')
# apt-get install ${plugins}
</pre>
Ensuite on procéde à l'installation:
<pre>
# apt-get install ${plugins}
</pre>

Domotech esp8266 api

2019-03-30T15:36:10Z

Tala : /* Configuration */

= Commandes =
Déclaration de cette API dans le fichier ''ApiCommandServer.cpp''.
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/cmd/locate
||
*vide
|align='center'|
GET
||
Fait clignoter la led (D4) présente sur le module
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/cmd/reboot
||
*vide
|align='center'|
GET
||
Redémarre le module
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/cmd/disable
||
*vide
|align='center'|
GET
||
Désactive le module. Un module désactivé ne répondra plus à aucun ordre, notamment de modification de GPIO.
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/cmd/enable
||
* vide
|align='center'|
GET
||
Active le module.
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

= GPIO =
Déclaration de cette API dans le fichier ''ApiGpioServer.cpp''.
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/gpio
||
*vide
|align='center'|
GET
||
Affiche l'état des broches
||
*200 : { "gpios" : { "A0" : { "state" : 9, "time" : 0 } , "D0" : { "state" : 0, "time" : 0, "isr" : 0 } , "D1" : { "state" : 1, "time" : 0, "isr" : 0 } , "D2" : { "state" : 0, "time" : 0, "isr" : 0 } , "D3" : { "state" : 0, "time" : 0, "isr" : 0 } , "D4" : { "state" : 0, "time" : 0, "isr" : 0 } , "D5" : { "state" : 0, "time" : 0, "isr" : 0 } , "D6" : { "state" : 0, "time" : 0, "isr" : 0 } , "D7" : { "state" : 0, "time" : 0, "isr" : 0 } , "D8" : { "state" : 0, "time" : 0, "isr" : 0 } } }
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/gpio/mode
||
* ''gpio'' : broche à modifier (D0 - D7)
* ''mode'' : mode de la broche, ''i'' → ''INPUT'' et ''o'' → ''OUTPUT''
|align='center'|
GET
||
Modifie le mode d'une broche
||
*200 : si les deux paramètres sont présents
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/gpio/state
||
* ''gpio'' : broche à modifier (D0 - D7)
* ''state'' : état désiré de la broche, ''1'' → ''HIGH'' et ''0'' → ''LOW''
|align='center'|
GET
||
Récupère / modifie l'état d'une broche
||
*200 : si ''gpio'' est présent le retour correspondra au nouvel état de la broche → { "state" : 1 }
*400 : si ''gpio'' n'est pas présent
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/gpio/pwm
||
* ''gpio'' : broche à modifier (D0 - D7)
* ''pwm'' : état PWM désiré de la broche (''0'' - ''1024'')
|align='center'|
GET
||
Récupère / modifie l'état d'une broche
||
*200 : si ''gpio'' est présent le retour correspondra au nouvel état de la broche → { "state" : 650 }
*400 : si ''gpio'' n'est pas présent
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/gpio/toggle
||
* ''gpio'' : broche à modifier (D0 - D7)
|align='center'|
GET
||
Permet de basculer l'état d'une broche
||
*200 : si ''gpio'' est présent le retour correspondra au nouvel état de la broche → { "state" : 1 }
*400 : si ''gpio'' n'est pas présent
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/gpio/time
||
* ''gpio'' : broche à modifier (D0 - D7)
* ''time'' : durée de changement d'état de la broche (0 - 65535)
|align='center'|
GET
||
Permet de basculer l'état d'une broche pendant un certain nombre de secondes
||
*200 : si ''gpio'' est présent sans ''time'' → { "D1" : { "time" : 0 } }
*200 : si le paramètre ''time'' est présent le retour correspondra au nouvel état de la broche → { "state" : 1 }
*400 : si ''gpio'' n'est pas présent
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/gpio/isr
||
* ''gpio'' : broche à modifier (D0 - D7)
* ''isr'' : le type d'interruption
** ''0'' → pas d'ISR
** ''1'' → CHANGE
** ''2'' → RISING
** ''3'' → FALLING
|align='center'|
GET
||
Attache une interruption sur une broche
||
*200 : si le paramètre ''gpio'' est présent avec ''isr'' → { "D1" : { "isr" : 0 } }
*400 : si l'un des deux paramètres est manquant
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/gpio/serial
||
* ''start'' : démarre la lecture sur le port série (300 - 115200)
* ''stop'' : arrête la lecture sur le port série
* ''send'' : envoie un message sur le port série
|align='center'|
GET
||
Démarre / stop la lecture sur le port série ou envoie / retourne les données dans le tampon du port série (UART)
||
*200 : si le paramètre ''start'' est présent, il correspond à la vitesse du port série
*200 : si le paramètre ''stop'' est présent, cela stoppera la lecture
*200 : si le paramètre ''send'' est présent, cela enverra les données sur le port série
*200 : si aucun paramètre n'est présent, cela retournera le contenu du tampon
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

= Température =
Déclaration de cette API dans le fichier ''ApiTempServer.cpp''.
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/temp
||
*vide
|align='center'|
GET
||
Affiche les températures de tous les thermomètres ou false si aucun thermomètre n'est présent
||
*200 : { "temperatures" : [ 25.325, 38.152 ] }
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/temp/res
||
* id : le numéro du thermomètre
* res : la résolution voulue
|align='center'|
GET
||Affiche la résolution si le paramètre ''res'' est absent
Configure la résolution si le paramètre ''res'' est présent
||
*200 : si l'identifiant est valide
*404 : si l'identifiant n'est pas valide
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/temp/addr
||
* vide
|align='center'|
GET
||
Affiche les adresses des thermomètres
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
= Configuration =
Déclaration de cette API dans le fichier ''ApiConfigServer.cpp''.
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/conf
||
*vide
|align='center'|
GET
||
Permet d'afficher la configuration
||
*200 :
[[Fichier:api_config_retrieval_example.png]]
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/conf/apply
||
* vide
|align='center'|
GET
||
Permet d'appliquer une configuration (redémarre simplement le module)
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/conf/save
||
*''hostname'' : nom du module
*''wifimode'' :
** ''1'' → station mode
** ''2'' → AP mode
** ''3'' → AP_STA (both)
*''sta_ssid'' : SSID of the AP to connect to (''wifimode'' must be 1 or 3)
*''sta_pwd'' : password of the AP to connect to (''wifimode'' must be 1 or 3)
*''ap_ssid'' : AP SSID (''wifimode'' must be 2 or 3)
*''ap_pwd'' : AP password (''wifimode'' must be 2 or 3)
*''ap_pwr'' : AP output power (''wifimode'' must be 1 or 3)
*''ipconfig'' : ip configuration, ''0'' for DHCP, ''1'' for static
*''ipaddr'' : ip address (''ipconfig'' must be ''1'')
*''netmask'' : ip netmask (''ipconfig'' must be ''1'')
*''gateway'' : ip gateway (''ipconfig'' must be ''1'')
*''dns'' : ip dns (''ipconfig'' must be ''1'')
*''to_apply'' : will apply configuration by rebooting the device
*''disabled'' : if ''1'' disable the module otherwise module is active with ''0''
*''is_temp'' : if ''1'' temperature sensor will be active, otherwise ''0'' to disable
*''temp_pin'' : GPIO to look
*''isr''
*''is_serial''
*''start''
|align='center'|
GET
||
Permet de modifier la configuration du module
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/conf/reset
||
* vide
|align='center'|
GET
||
Efface la configuration et redémarre le module
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
= Firmware =
Déclaration de cette API dans le fichier ''ApiUpdateServer.cpp''.
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/firmware/update
||
*server: l'adresse IP du serveur
*name: le nom du firmware
|align='center'|
GET
||
Met à jour le micrologiciel du module avec le fichier présent à ''http://ip_du_serveur/nom_du_firmware''
||
*200 :
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/firmware/info
||
* vide
|align='center'|
GET
||
Affiche des informations sur la mise à jour. En cas de mise à jour réussie, comme le module redémarre automatiquement, l'état n'est pas cohérent (affiche une erreur)
||
*200 : si l'identifiant est valide
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

Domotech esp8266 api

2019-03-30T15:30:16Z

Tala : /* Configuration */

Fichier:Api config retrieval example.png

2019-03-30T15:28:57Z

Tala :

Domotech esp8266 api

2019-03-30T14:41:20Z

Tala : /* GPIO */

= Commandes =
Déclaration de cette API dans le fichier ''ApiCommandServer.cpp''.
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/cmd/locate
||
*vide
|align='center'|
GET
||
Fait clignoter la led (D4) présente sur le module
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/cmd/reboot
||
*vide
|align='center'|
GET
||
Redémarre le module
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/cmd/disable
||
*vide
|align='center'|
GET
||
Désactive le module. Un module désactivé ne répondra plus à aucun ordre, notamment de modification de GPIO.
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/cmd/enable
||
* vide
|align='center'|
GET
||
Active le module.
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

= GPIO =
Déclaration de cette API dans le fichier ''ApiGpioServer.cpp''.
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/gpio
||
*vide
|align='center'|
GET
||
Affiche l'état des broches
||
*200 : { "gpios" : { "A0" : { "state" : 9, "time" : 0 } , "D0" : { "state" : 0, "time" : 0, "isr" : 0 } , "D1" : { "state" : 1, "time" : 0, "isr" : 0 } , "D2" : { "state" : 0, "time" : 0, "isr" : 0 } , "D3" : { "state" : 0, "time" : 0, "isr" : 0 } , "D4" : { "state" : 0, "time" : 0, "isr" : 0 } , "D5" : { "state" : 0, "time" : 0, "isr" : 0 } , "D6" : { "state" : 0, "time" : 0, "isr" : 0 } , "D7" : { "state" : 0, "time" : 0, "isr" : 0 } , "D8" : { "state" : 0, "time" : 0, "isr" : 0 } } }
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/gpio/mode
||
* ''gpio'' : broche à modifier (D0 - D7)
* ''mode'' : mode de la broche, ''i'' → ''INPUT'' et ''o'' → ''OUTPUT''
|align='center'|
GET
||
Modifie le mode d'une broche
||
*200 : si les deux paramètres sont présents
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/gpio/state
||
* ''gpio'' : broche à modifier (D0 - D7)
* ''state'' : état désiré de la broche, ''1'' → ''HIGH'' et ''0'' → ''LOW''
|align='center'|
GET
||
Récupère / modifie l'état d'une broche
||
*200 : si ''gpio'' est présent le retour correspondra au nouvel état de la broche → { "state" : 1 }
*400 : si ''gpio'' n'est pas présent
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/gpio/pwm
||
* ''gpio'' : broche à modifier (D0 - D7)
* ''pwm'' : état PWM désiré de la broche (''0'' - ''1024'')
|align='center'|
GET
||
Récupère / modifie l'état d'une broche
||
*200 : si ''gpio'' est présent le retour correspondra au nouvel état de la broche → { "state" : 650 }
*400 : si ''gpio'' n'est pas présent
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/gpio/toggle
||
* ''gpio'' : broche à modifier (D0 - D7)
|align='center'|
GET
||
Permet de basculer l'état d'une broche
||
*200 : si ''gpio'' est présent le retour correspondra au nouvel état de la broche → { "state" : 1 }
*400 : si ''gpio'' n'est pas présent
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/gpio/time
||
* ''gpio'' : broche à modifier (D0 - D7)
* ''time'' : durée de changement d'état de la broche (0 - 65535)
|align='center'|
GET
||
Permet de basculer l'état d'une broche pendant un certain nombre de secondes
||
*200 : si ''gpio'' est présent sans ''time'' → { "D1" : { "time" : 0 } }
*200 : si le paramètre ''time'' est présent le retour correspondra au nouvel état de la broche → { "state" : 1 }
*400 : si ''gpio'' n'est pas présent
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/gpio/isr
||
* ''gpio'' : broche à modifier (D0 - D7)
* ''isr'' : le type d'interruption
** ''0'' → pas d'ISR
** ''1'' → CHANGE
** ''2'' → RISING
** ''3'' → FALLING
|align='center'|
GET
||
Attache une interruption sur une broche
||
*200 : si le paramètre ''gpio'' est présent avec ''isr'' → { "D1" : { "isr" : 0 } }
*400 : si l'un des deux paramètres est manquant
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/gpio/serial
||
* ''start'' : démarre la lecture sur le port série (300 - 115200)
* ''stop'' : arrête la lecture sur le port série
* ''send'' : envoie un message sur le port série
|align='center'|
GET
||
Démarre / stop la lecture sur le port série ou envoie / retourne les données dans le tampon du port série (UART)
||
*200 : si le paramètre ''start'' est présent, il correspond à la vitesse du port série
*200 : si le paramètre ''stop'' est présent, cela stoppera la lecture
*200 : si le paramètre ''send'' est présent, cela enverra les données sur le port série
*200 : si aucun paramètre n'est présent, cela retournera le contenu du tampon
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

= Température =
Déclaration de cette API dans le fichier ''ApiTempServer.cpp''.
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/temp
||
*vide
|align='center'|
GET
||
Affiche les températures de tous les thermomètres ou false si aucun thermomètre n'est présent
||
*200 : { "temperatures" : [ 25.325, 38.152 ] }
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/temp/res
||
* id : le numéro du thermomètre
* res : la résolution voulue
|align='center'|
GET
||Affiche la résolution si le paramètre ''res'' est absent
Configure la résolution si le paramètre ''res'' est présent
||
*200 : si l'identifiant est valide
*404 : si l'identifiant n'est pas valide
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/temp/addr
||
* vide
|align='center'|
GET
||
Affiche les adresses des thermomètres
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
= Configuration =
Déclaration de cette API dans le fichier ''ApiConfigServer.cpp''.
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/conf
||
*vide
|align='center'|
GET
||

||
*200 :
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/conf/apply
||
* vide
|align='center'|
GET
||

||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/conf/save
||
*''hostname'' : nom du module
*''wifimode'' :
** ''1'' → station mode
** ''2'' → AP mode
** ''3'' → AP_STA (both)
*''sta_ssid'' : SSID of the AP to connect to (''wifimode'' must be 1 or 3)
*''sta_pwd'' : password of the AP to connect to (''wifimode'' must be 1 or 3)
*''ap_ssid'' : AP SSID (''wifimode'' must be 2 or 3)
*''ap_pwd'' : AP password (''wifimode'' must be 2 or 3)
*''ap_pwr'' : AP output power (''wifimode'' must be 1 or 3)
*''ipconfig'' : ip configuration, ''0'' for DHCP, ''1'' for static
*''ipaddr'' : ip address (''ipconfig'' must be ''1'')
*''netmask'' : ip netmask (''ipconfig'' must be ''1'')
*''gateway'' : ip gateway (''ipconfig'' must be ''1'')
*''dns'' : ip dns (''ipconfig'' must be ''1'')
*''to_apply'' : will apply configuration by rebooting the device
*''disabled'' : if ''1'' disable the module otherwise module is active with ''0''
*''is_temp'' : if ''1'' temperature sensor will be active, otherwise ''0'' to disable
*''temp_pin'' : GPIO to look
*''isr''
*''is_serial''
*''start''
|align='center'|
GET
||

||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/conf/reset
||
* vide
|align='center'|
GET
||

||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

Roadmap orange pi music

2019-01-20T19:34:15Z

Tala : /* TODO */

== TODO ==
*<strike>Ajouter au script d'installation la partie Fail2Ban</strike>
*faire un script de démarrage pour iptables
*<strike>Tester cet API : https://www.yt2mp3s.me/@api/button/mp3/MqmN-5g3_5Y</strike>
*<strike>intégrer youtube-dl</strike>
* mettre à jour youtube-dl avec un cron

== Fonctionnalités ==
* Réfléchir à un système de playlist, avec ou sans indexation;

== API ==
* Finir la partie relative à Youtube ;
* Procéder à une authentification (OAuth);
== GUI ==
===Partie device===
* Listage des périphériques USB montés / démontés
[[Fichier:device_available.png|centré|500px]]
* Montage d'un périphérique USB
[[Fichier:device_mount.png|centré|500px]]
* Parcours d'un périphérique USB monté
{|
|-
||
[[Fichier:device_explorer.png|centré|500px]]
||
[[Fichier:device_explorer1.png|centré|500px]]
|}
===Partie share===
* Parcours des partages SMB/CIFS sur un hôte
[[Fichier:share_host.png|centré|500px]]
* Montage d'un partage avec automount
[[Fichier:share_mount.png|centré|500px]]
*Parcours d'un partage
{|
|-
||
[[Fichier:share_explorer1.png|centré|500px]]
||
[[Fichier:share_explorer.png|centré|500px]]
|}
===Partie player===
*Lecture d'un MP3 avec tag
{|
|-
||
[[Fichier:player_1.png|centré|500px]]
||
[[Fichier:player_2.png|centré|500px]]
|}

== Kernel ==
* Écrire un démon ou faire un CRON ;
* Utiliser un fichier de configuration global ;
* Tester la présence de périphérique USB ;

== BUGS ==
=== BDD ===
* La partie indexation mérite réflexion, dans cet état elle est trop restrictive et nécessite un TAG trop parfait pour réussir. Voir pour faire une indexation plus souple qui réussie même en l'absence de certain champ (artiste, album, genre, pochette, etc...). Problème à régler dans la classe ''DaoMusique'' et ''Tag''.
* Problème de typage pour le champ ''duration'', il faut le repasser en secondes pour que cela fonctionne
<pre>
select * from music;
+----------+------------------------+---------+------+----------+----------------------------------------------+----------+
| id_music | title | bitrate | hit | duration | path | id_image |
+----------+------------------------+---------+------+----------+----------------------------------------------+----------+
| 1 | Five More hours | 128 | 0 | 3 | Deorro & Chris Brown Five More Hours.mp3 | 1 |
| 2 | Milkshake (TRFN Remix) | 192 | 0 | 2 | 2018/Kelis - Milkshake (TRFN Remix).mp3 | 2 |
| 3 | Uptown Funk | 128 | 0 | 4 | Mark Ronson ft. Bruno Mars - Uptown Funk.mp3 | 3 |
| 4 | Want To Want Me | 128 | 0 | 3 | Jason Derulo - Want To Want Me.mp3 | 4 |
| 5 | Love Me Like You Do | 128 | 0 | 4 | Ellie Goulding - Love Me Like You Do.mp3 | 1 |
| 6 | Take Me To Church | 128 | 0 | 4 | Hozier - Take Me To Church.mp3 | 1 |
+----------+------------------------+---------+------+----------+----------------------------------------------+----------+
</pre>

Roadmap orange pi music

2019-01-13T23:04:15Z

Tala : /* TODO */

== TODO ==
*Ajouter au script d'installation la partie Fail2Ban
*Tester cet API : https://www.yt2mp3s.me/@api/button/mp3/MqmN-5g3_5Y

== Fonctionnalités ==
* Réfléchir à un système de playlist, avec ou sans indexation;

== API ==
* Finir la partie relative à Youtube ;
* Procéder à une authentification (OAuth);
== GUI ==
===Partie device===
* Listage des périphériques USB montés / démontés
[[Fichier:device_available.png|centré|500px]]
* Montage d'un périphérique USB
[[Fichier:device_mount.png|centré|500px]]
* Parcours d'un périphérique USB monté
{|
|-
||
[[Fichier:device_explorer.png|centré|500px]]
||
[[Fichier:device_explorer1.png|centré|500px]]
|}
===Partie share===
* Parcours des partages SMB/CIFS sur un hôte
[[Fichier:share_host.png|centré|500px]]
* Montage d'un partage avec automount
[[Fichier:share_mount.png|centré|500px]]
*Parcours d'un partage
{|
|-
||
[[Fichier:share_explorer1.png|centré|500px]]
||
[[Fichier:share_explorer.png|centré|500px]]
|}
===Partie player===
*Lecture d'un MP3 avec tag
{|
|-
||
[[Fichier:player_1.png|centré|500px]]
||
[[Fichier:player_2.png|centré|500px]]
|}

== Kernel ==
* Écrire un démon ou faire un CRON ;
* Utiliser un fichier de configuration global ;
* Tester la présence de périphérique USB ;

== BUGS ==
=== BDD ===
* La partie indexation mérite réflexion, dans cet état elle est trop restrictive et nécessite un TAG trop parfait pour réussir. Voir pour faire une indexation plus souple qui réussie même en l'absence de certain champ (artiste, album, genre, pochette, etc...). Problème à régler dans la classe ''DaoMusique'' et ''Tag''.
* Problème de typage pour le champ ''duration'', il faut le repasser en secondes pour que cela fonctionne
<pre>
select * from music;
+----------+------------------------+---------+------+----------+----------------------------------------------+----------+
| id_music | title | bitrate | hit | duration | path | id_image |
+----------+------------------------+---------+------+----------+----------------------------------------------+----------+
| 1 | Five More hours | 128 | 0 | 3 | Deorro & Chris Brown Five More Hours.mp3 | 1 |
| 2 | Milkshake (TRFN Remix) | 192 | 0 | 2 | 2018/Kelis - Milkshake (TRFN Remix).mp3 | 2 |
| 3 | Uptown Funk | 128 | 0 | 4 | Mark Ronson ft. Bruno Mars - Uptown Funk.mp3 | 3 |
| 4 | Want To Want Me | 128 | 0 | 3 | Jason Derulo - Want To Want Me.mp3 | 4 |
| 5 | Love Me Like You Do | 128 | 0 | 4 | Ellie Goulding - Love Me Like You Do.mp3 | 1 |
| 6 | Take Me To Church | 128 | 0 | 4 | Hozier - Take Me To Church.mp3 | 1 |
+----------+------------------------+---------+------+----------+----------------------------------------------+----------+
</pre>

Roadmap orange pi music

2019-01-13T22:54:42Z

Tala : /* Fonctionnalités */

== TODO ==
Ajouter au script d'installation la partie Fail2Ban

== Fonctionnalités ==
* Réfléchir à un système de playlist, avec ou sans indexation;

== API ==
* Finir la partie relative à Youtube ;
* Procéder à une authentification (OAuth);
== GUI ==
===Partie device===
* Listage des périphériques USB montés / démontés
[[Fichier:device_available.png|centré|500px]]
* Montage d'un périphérique USB
[[Fichier:device_mount.png|centré|500px]]
* Parcours d'un périphérique USB monté
{|
|-
||
[[Fichier:device_explorer.png|centré|500px]]
||
[[Fichier:device_explorer1.png|centré|500px]]
|}
===Partie share===
* Parcours des partages SMB/CIFS sur un hôte
[[Fichier:share_host.png|centré|500px]]
* Montage d'un partage avec automount
[[Fichier:share_mount.png|centré|500px]]
*Parcours d'un partage
{|
|-
||
[[Fichier:share_explorer1.png|centré|500px]]
||
[[Fichier:share_explorer.png|centré|500px]]
|}
===Partie player===
*Lecture d'un MP3 avec tag
{|
|-
||
[[Fichier:player_1.png|centré|500px]]
||
[[Fichier:player_2.png|centré|500px]]
|}

== Kernel ==
* Écrire un démon ou faire un CRON ;
* Utiliser un fichier de configuration global ;
* Tester la présence de périphérique USB ;

== BUGS ==
=== BDD ===
* La partie indexation mérite réflexion, dans cet état elle est trop restrictive et nécessite un TAG trop parfait pour réussir. Voir pour faire une indexation plus souple qui réussie même en l'absence de certain champ (artiste, album, genre, pochette, etc...). Problème à régler dans la classe ''DaoMusique'' et ''Tag''.
* Problème de typage pour le champ ''duration'', il faut le repasser en secondes pour que cela fonctionne
<pre>
select * from music;
+----------+------------------------+---------+------+----------+----------------------------------------------+----------+
| id_music | title | bitrate | hit | duration | path | id_image |
+----------+------------------------+---------+------+----------+----------------------------------------------+----------+
| 1 | Five More hours | 128 | 0 | 3 | Deorro & Chris Brown Five More Hours.mp3 | 1 |
| 2 | Milkshake (TRFN Remix) | 192 | 0 | 2 | 2018/Kelis - Milkshake (TRFN Remix).mp3 | 2 |
| 3 | Uptown Funk | 128 | 0 | 4 | Mark Ronson ft. Bruno Mars - Uptown Funk.mp3 | 3 |
| 4 | Want To Want Me | 128 | 0 | 3 | Jason Derulo - Want To Want Me.mp3 | 4 |
| 5 | Love Me Like You Do | 128 | 0 | 4 | Ellie Goulding - Love Me Like You Do.mp3 | 1 |
| 6 | Take Me To Church | 128 | 0 | 4 | Hozier - Take Me To Church.mp3 | 1 |
+----------+------------------------+---------+------+----------+----------------------------------------------+----------+
</pre>

Music sender api

2019-01-13T11:45:41Z

Tala : /* Share */

=User=
L'objet user est composé comme suit : {"id":"1","pseudo":"tala","email":"tala@tala.com","id_image":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/user
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets utilisateur
||
*200 : si l'objet existe
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
*vide
|align='center'|
GET
||
Retourne un objet utilisateur
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/
||
* pseudo : le pseudo de l'utilisateur
* email : le mail de l'utilisateur
* password : le mot de passe de l'utilisateur
* image : l'identifiant de l'image
|align='center'|
POST
||
Crée un nouvel utilisateur et renvoie son identifiant
||
*201 : si la création réussi avec en réponse l'identifiant (eg. {"id":1} )
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/email/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
* email : le mail de l'utilisateur
|align='center'|
PUT
||
Modifie l'email du compte
||
*200 : si la modification réussie
*400 : si une erreur survient
*404 : si l'utilisateur n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/password/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
* password : le nouveau mot de passe utilisateur
|align='center'|
PUT
||
Modifie le mot de passe du compte
||
*200 : si la modification réussie
*400 : si une erreur survient
*404 : si l'utilisateur n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/$$ID$$
*$$ID$$ : un id de d'artiste
||
*vide
|align='center'|
DELETE
||
Efface l'utilisateur
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
*400 : si une erreur survient
||
[[Fichier:implemented_red_cross.png|center|40px]]
|}

=Genre=
L'objet genre est composé comme suit : {"id": "1", "name": "Electro-Jazz"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/genre
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets genre
||
*200 : si l'objet existe
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
GET
||
Retourne un objet genre
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un genre
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets genre
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre
||
*genre : le nom du genre
|align='center'|
POST
||
Créé un nouvel objet genre
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*genre : le nom du genre
|align='center'|
PUT
||
Modifie le nom du genre
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
DELETE
||
Efface le genre
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Artist=
L'objet artiste est composé comme suit : {"id":"84","name":"Yolanda Be Cool & Dcup","id_image":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/artist
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets artiste
||
*200 : si l'objet existe
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
GET
||
Retourne un objet artiste
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets artiste
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist
||
*name : le nom de l'artist
*image : l'identifiant d'une image (optionnel)
|align='center'|
POST
||
Créé un nouvel objet artiste
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/name/$$ID$$
*$$ID$$ : un id d'artiste
||
*name: le nom de l’artiste
|align='center'|
PUT
||
Modifie le nom de l'artiste
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/image/$$ID$$
*$$ID$$ : un id d'artiste
||
*image: l'identifiant de l'image
|align='center'|
PUT
||
Modifie l'image de l'artiste
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
DELETE
||
Efface l'artiste
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Album=
L'objet album est composé comme suit : {"id":"1","album":"Electro Swing Collection 1","coverId":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/album
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
GET
||
Retourne un objet album
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/artist/$$ID$$
*$$ID$$ : l'identifiant d'un artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/genre/$$ID$$
*$$ID$$ : l'identifiant d'un genre
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'album
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album
||
*name : le nom de l'album
*image : l'identifiant d'une image (optionnel)
|align='center'|
POST
||
Créé un nouvel objet album
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/name/$$ID$$
*$$ID$$ : un id d'album
||
*name: le nom de l’album
|align='center'|
PUT
||
Modifie le nom de l'album
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/image/$$ID$$
*$$ID$$ : un id d'album
||
*image: l'identifiant de l'image
|align='center'|
PUT
||
Modifie l'image de l'album
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
DELETE
||
Efface l'album
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Music=
L'objet musique est composé comme suit : {"id":"1","title":"All Night","artists":["1"],"genres":["1"],"bitrate":"128","hit":"4","duration":"163","id_image":"1"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/music/info/$$ID$$
* $$ID$$ : un identifiant de musique
||
*vide
|align='center'|
GET
||
Retourne un objet musique au format Json
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/content/$$ID$$
* $$ID$$ : un identifiant de musique
||
*vide
|align='center'|
GET
||
Retourne le contenu de la musique (fichier son)<br>
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/album/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objet musiques au format Json appartenant à l'album associé à l'identifiant
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/artist/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objet musiques au format Json dont le créateur est l'artiste associé à l'identifiant
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Image=
L'objet image est composé comme suit : {"id": "1", "content": "/9j/4B4…T0+7RRW/2Q==","mime":"image\jpeg","hash":"0aebaad7…4f265bd"} }
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/images
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets image
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image/info/$$ID$$
*$$ID$$ : un id d'image
||
*vide
|align='center'|
GET
||
Retourne un objet image
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image/content/$$ID$$
*$$ID$$ : un id d'image
||
*vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image
||
*content : le contenu du fichier image
|align='center'|
POST
||
Créé un nouvel objet image
||
*200 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_red_cross.png|center|40px]]
|-
||
/api/image/$$ID$$
*$$ID$$ : un id d'image
||
*content : le contenu du fichier image
|align='center'|
PUT
||
Modifie l'image
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_red_cross.png|center|40px]]
|-
||
/api/image/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
DELETE
||
Efface l'image
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Device=
L'objet périphérique est composé comme suit : {"name":"\/dev\/sda1","label":"MUSIC","size":"7.2 GiB","UUID":"84B9-A853","fstype":"vfat"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/device
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les périphériques
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/list/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
** extension : un filtre par extension de fichier (optionnel)
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste récursive des fichiers
||
*200 : si l'UUID existe
*400 : si l'UUID n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/explore/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
** extension : un filtre par extension de fichier (optionnel)
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste des fichiers et dossiers:

{"directories":["Pop","Rock"],"files":["Gala - Freed From Desire.mp3","13)Jacques Your Body (Make Me Sweat)(Jcf Pitch Edit).mp3"]}
||
*200 : si l'UUID existe
*400 : si l'UUID n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/content/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
** download : si présent, le navigateur téléchargera le fichier ('Content-disposition: attachment;' au lieu de 'Content-disposition: inline;')
||
* vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/tag/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
||
* vide
|align='center'|
GET
||
Retourne un tableau contenant les tags du ou des fichiers présent dans le répertoire
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/size/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
||
* vide
|align='center'|
GET
||
Retourne la taille du fichiers ou répertoire
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mounted
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des périphériques montés
||
*200 : si aucune erreur
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/umounted
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des périphériques démontés
||
*200 : si aucune erreur
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mount/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* vide
|align='center'|
POST
||
Monte le périphérique sur le système
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/enable/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* vide
|align='center'|
POST
||
Active le montage du périphérique au démarrage du système
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/index/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
||
* vide
|align='center'|
POST
||
Index le répertoire ou le fichier désigné par le paramètre path
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mount/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*vide
|align='center'|
DELETE
||
Démonte le périphérique du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/enable/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*vide
|align='center'|
DELETE
||
Désactive le montage du périphérique au démarrage du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Share=
L'objet partage est composé comme suit : {"host":"hades","share":"downloads","login":"nobody"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/share
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les partages montés
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/list/$$HOST$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste des partages disponibles sur l'hôte
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/list/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
** extension : filtre à appliquer sur les fichiers (optionnel)
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste récursive de tous les fichiers disponibles sur le partage

Attention, l'appel peut être long, surtout lorsque les partages contiennent beaucoup de fichiers
||
* 200 : si le partage existe
* 400 : si le partage n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/explore/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
** extension : filtre à appliquer sur les fichiers (optionnel)
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des fichiers
||
*200 : si le partage existe
*400 : si le partage n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/content/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
** download : si présent, le navigateur téléchargera le fichier ('Content-disposition: attachment;' au lieu de 'Content-disposition: inline;')
||
*vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/tag/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
||
*vide
|align='center'|
GET
||
Retourne un tableau contenant les tags du ou des fichiers présent dans le répertoire
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/size/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
||
*vide
|align='center'|
GET
||
Retourne la taille du fichiers ou répertoire
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* login : le login à utiliser (optionnel)
* password : le mot de passe associé (optionnel)
|align='center'|
POST
||
Monte le partage sur le système. Si aucun couple d'authentification n'est fourni, ''nobody'' sera utilisé
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/index/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
||
*vide
|align='center'|
POST
||
Index le répertoire ou le fichier désigné par le paramètre path
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
*vide
|align='center'|
DELETE
||
Démonte le partage du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

= Youtube =
Permet de récupérer des informations sur les vidéo Youtube
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/youtube/info/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère des informations sur la vidéo Youtube. Voici un exemple:

{

"url":"https:\/\/www.youtube.com\/watch?v=eVGrSCrRiy8",

"cover":"https:\/\/i.ytimg.com\/vi\/eVGrSCrRiy8\/maxresdefault.jpg",

"author":"ElectroDanceMixes",

"title":"FESTIVAL MIX - Best EDM & Electro House Dance Party Mix 2018",

"id":"eVGrSCrRiy8",

"videos":["..."]

}
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/youtube/cover/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère la ''pochette'' de la vidéo
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/youtube/listen/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère le contenu de la vidéo
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Player=
Joue la musique sur la carte son du Pi (intégration VLC)
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/player/pause
||
*vide
|align='center'|
GET
||
Met en pause la music
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/stop
||
*vide
|align='center'|
GET
||
Stop la lecture
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/volume/$$PERCENT$$
*$$PERCENT$$ : le volume en poucentage
||
*vide
|align='center'|
GET
||
Règle le volume du lecteur
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/device/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*path : un chemin sur le périphérique
|align='center'|
POST
||
Joue le fichier désigné par ''path'' sur le périphérique ''UUID''
||
*200 : si le fichier et le périphérique existent
*400 : si le fichier ou le périphérique n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
*path : un chemin sur le partage
|align='center'|
POST
||
Joue le fichier désigné par ''path'' sur le partage ''SHARE'' sur l'hôte ''HOST''
||
*200 : si le fichier, le partage et l'hôte existent
*400 : si le fichier, le partage ou l'hôte n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/youtube/$$ID$$
||
* $$ID$$ : un ID de vidéo Youtube (https://www.youtube.com/watch?v=mEYyVY9ffDM → mEYyVY9ffDM)
|align='center'|
POST
||
Joue le son de la vidéo, quand c'est possible (certaines vidéos ne fonctionnent pas)
||
* 200 : si la vidéo existe
* 400 : si le vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/url
||
* path : un lien vers un fichier musical
|align='center'|
POST
||
Joue le fichier
||
* 200 : si la fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Indexer (WIP)=
Permet d'avoir des informations sur les travaux d'indexation en cours. Voici un exemple:
* d'identifiant de travail → 5c2e724887be4;
* d'informations sur un travail → {"files":{"directory":"\/opt\/mount\/192.168.1.252-torrent\/\/Best of POP JCF","total":8,"current":[],"processed":8,"remaining":0,"success":[1,2,3,4,5,6,7,8],"failure":[]},"time":{"start":1546547784,"elapsed":1,"end":1546547785},"state":2}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/index/run
||
*vide
|align='center'|
GET
||
Retourne la liste des identifiants des travaux en cours
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info
||
*vide
|align='center'|
GET
||
Récupère la liste des identifiants des travaux disponibles pour consultation
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
GET
||
Récupère les informations liées au travail désigné par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/run/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
DELETE
||
Stop le travail d'indexation désignè par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
DELETE
||
Supprime les informations liées au travail désigné par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]

Music sender api

2019-01-13T11:45:21Z

Tala : /* Device */

=User=
L'objet user est composé comme suit : {"id":"1","pseudo":"tala","email":"tala@tala.com","id_image":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/user
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets utilisateur
||
*200 : si l'objet existe
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
*vide
|align='center'|
GET
||
Retourne un objet utilisateur
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/
||
* pseudo : le pseudo de l'utilisateur
* email : le mail de l'utilisateur
* password : le mot de passe de l'utilisateur
* image : l'identifiant de l'image
|align='center'|
POST
||
Crée un nouvel utilisateur et renvoie son identifiant
||
*201 : si la création réussi avec en réponse l'identifiant (eg. {"id":1} )
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/email/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
* email : le mail de l'utilisateur
|align='center'|
PUT
||
Modifie l'email du compte
||
*200 : si la modification réussie
*400 : si une erreur survient
*404 : si l'utilisateur n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/password/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
* password : le nouveau mot de passe utilisateur
|align='center'|
PUT
||
Modifie le mot de passe du compte
||
*200 : si la modification réussie
*400 : si une erreur survient
*404 : si l'utilisateur n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/$$ID$$
*$$ID$$ : un id de d'artiste
||
*vide
|align='center'|
DELETE
||
Efface l'utilisateur
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
*400 : si une erreur survient
||
[[Fichier:implemented_red_cross.png|center|40px]]
|}

=Genre=
L'objet genre est composé comme suit : {"id": "1", "name": "Electro-Jazz"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/genre
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets genre
||
*200 : si l'objet existe
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
GET
||
Retourne un objet genre
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un genre
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets genre
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre
||
*genre : le nom du genre
|align='center'|
POST
||
Créé un nouvel objet genre
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*genre : le nom du genre
|align='center'|
PUT
||
Modifie le nom du genre
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
DELETE
||
Efface le genre
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Artist=
L'objet artiste est composé comme suit : {"id":"84","name":"Yolanda Be Cool & Dcup","id_image":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/artist
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets artiste
||
*200 : si l'objet existe
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
GET
||
Retourne un objet artiste
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets artiste
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist
||
*name : le nom de l'artist
*image : l'identifiant d'une image (optionnel)
|align='center'|
POST
||
Créé un nouvel objet artiste
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/name/$$ID$$
*$$ID$$ : un id d'artiste
||
*name: le nom de l’artiste
|align='center'|
PUT
||
Modifie le nom de l'artiste
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/image/$$ID$$
*$$ID$$ : un id d'artiste
||
*image: l'identifiant de l'image
|align='center'|
PUT
||
Modifie l'image de l'artiste
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
DELETE
||
Efface l'artiste
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Album=
L'objet album est composé comme suit : {"id":"1","album":"Electro Swing Collection 1","coverId":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/album
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
GET
||
Retourne un objet album
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/artist/$$ID$$
*$$ID$$ : l'identifiant d'un artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/genre/$$ID$$
*$$ID$$ : l'identifiant d'un genre
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'album
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album
||
*name : le nom de l'album
*image : l'identifiant d'une image (optionnel)
|align='center'|
POST
||
Créé un nouvel objet album
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/name/$$ID$$
*$$ID$$ : un id d'album
||
*name: le nom de l’album
|align='center'|
PUT
||
Modifie le nom de l'album
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/image/$$ID$$
*$$ID$$ : un id d'album
||
*image: l'identifiant de l'image
|align='center'|
PUT
||
Modifie l'image de l'album
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
DELETE
||
Efface l'album
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Music=
L'objet musique est composé comme suit : {"id":"1","title":"All Night","artists":["1"],"genres":["1"],"bitrate":"128","hit":"4","duration":"163","id_image":"1"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/music/info/$$ID$$
* $$ID$$ : un identifiant de musique
||
*vide
|align='center'|
GET
||
Retourne un objet musique au format Json
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/content/$$ID$$
* $$ID$$ : un identifiant de musique
||
*vide
|align='center'|
GET
||
Retourne le contenu de la musique (fichier son)<br>
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/album/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objet musiques au format Json appartenant à l'album associé à l'identifiant
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/artist/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objet musiques au format Json dont le créateur est l'artiste associé à l'identifiant
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Image=
L'objet image est composé comme suit : {"id": "1", "content": "/9j/4B4…T0+7RRW/2Q==","mime":"image\jpeg","hash":"0aebaad7…4f265bd"} }
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/images
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets image
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image/info/$$ID$$
*$$ID$$ : un id d'image
||
*vide
|align='center'|
GET
||
Retourne un objet image
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image/content/$$ID$$
*$$ID$$ : un id d'image
||
*vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image
||
*content : le contenu du fichier image
|align='center'|
POST
||
Créé un nouvel objet image
||
*200 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_red_cross.png|center|40px]]
|-
||
/api/image/$$ID$$
*$$ID$$ : un id d'image
||
*content : le contenu du fichier image
|align='center'|
PUT
||
Modifie l'image
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_red_cross.png|center|40px]]
|-
||
/api/image/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
DELETE
||
Efface l'image
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Device=
L'objet périphérique est composé comme suit : {"name":"\/dev\/sda1","label":"MUSIC","size":"7.2 GiB","UUID":"84B9-A853","fstype":"vfat"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/device
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les périphériques
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/list/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
** extension : un filtre par extension de fichier (optionnel)
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste récursive des fichiers
||
*200 : si l'UUID existe
*400 : si l'UUID n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/explore/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
** extension : un filtre par extension de fichier (optionnel)
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste des fichiers et dossiers:

{"directories":["Pop","Rock"],"files":["Gala - Freed From Desire.mp3","13)Jacques Your Body (Make Me Sweat)(Jcf Pitch Edit).mp3"]}
||
*200 : si l'UUID existe
*400 : si l'UUID n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/content/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
** download : si présent, le navigateur téléchargera le fichier ('Content-disposition: attachment;' au lieu de 'Content-disposition: inline;')
||
* vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/tag/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
||
* vide
|align='center'|
GET
||
Retourne un tableau contenant les tags du ou des fichiers présent dans le répertoire
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/size/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
||
* vide
|align='center'|
GET
||
Retourne la taille du fichiers ou répertoire
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mounted
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des périphériques montés
||
*200 : si aucune erreur
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/umounted
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des périphériques démontés
||
*200 : si aucune erreur
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mount/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* vide
|align='center'|
POST
||
Monte le périphérique sur le système
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/enable/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* vide
|align='center'|
POST
||
Active le montage du périphérique au démarrage du système
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/index/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
||
* vide
|align='center'|
POST
||
Index le répertoire ou le fichier désigné par le paramètre path
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mount/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*vide
|align='center'|
DELETE
||
Démonte le périphérique du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/enable/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*vide
|align='center'|
DELETE
||
Désactive le montage du périphérique au démarrage du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Share=
L'objet partage est composé comme suit : {"host":"hades","share":"downloads","login":"nobody"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/share
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les partages montés
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/list/$$HOST$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste des partages disponibles sur l'hôte
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/list/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
** extension : filtre à appliquer sur les fichiers (optionnel)
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste récursive de tous les fichiers disponibles sur le partage

Attention, l'appel peut être long, surtout lorsque les partages contiennent beaucoup de fichiers
||
* 200 : si le partage existe
* 400 : si le partage n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/explore/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
** extension : filtre à appliquer sur les fichiers (optionnel)
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des fichiers
||
*200 : si le partage existe
*400 : si le partage n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/content/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
||
*vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/tag/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
||
*vide
|align='center'|
GET
||
Retourne un tableau contenant les tags du ou des fichiers présent dans le répertoire
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/size/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
||
*vide
|align='center'|
GET
||
Retourne la taille du fichiers ou répertoire
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* login : le login à utiliser (optionnel)
* password : le mot de passe associé (optionnel)
|align='center'|
POST
||
Monte le partage sur le système. Si aucun couple d'authentification n'est fourni, ''nobody'' sera utilisé
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/index/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
||
*vide
|align='center'|
POST
||
Index le répertoire ou le fichier désigné par le paramètre path
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
*vide
|align='center'|
DELETE
||
Démonte le partage du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

= Youtube =
Permet de récupérer des informations sur les vidéo Youtube
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/youtube/info/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère des informations sur la vidéo Youtube. Voici un exemple:

{

"url":"https:\/\/www.youtube.com\/watch?v=eVGrSCrRiy8",

"cover":"https:\/\/i.ytimg.com\/vi\/eVGrSCrRiy8\/maxresdefault.jpg",

"author":"ElectroDanceMixes",

"title":"FESTIVAL MIX - Best EDM & Electro House Dance Party Mix 2018",

"id":"eVGrSCrRiy8",

"videos":["..."]

}
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/youtube/cover/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère la ''pochette'' de la vidéo
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/youtube/listen/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère le contenu de la vidéo
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Player=
Joue la musique sur la carte son du Pi (intégration VLC)
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/player/pause
||
*vide
|align='center'|
GET
||
Met en pause la music
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/stop
||
*vide
|align='center'|
GET
||
Stop la lecture
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/volume/$$PERCENT$$
*$$PERCENT$$ : le volume en poucentage
||
*vide
|align='center'|
GET
||
Règle le volume du lecteur
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/device/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*path : un chemin sur le périphérique
|align='center'|
POST
||
Joue le fichier désigné par ''path'' sur le périphérique ''UUID''
||
*200 : si le fichier et le périphérique existent
*400 : si le fichier ou le périphérique n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
*path : un chemin sur le partage
|align='center'|
POST
||
Joue le fichier désigné par ''path'' sur le partage ''SHARE'' sur l'hôte ''HOST''
||
*200 : si le fichier, le partage et l'hôte existent
*400 : si le fichier, le partage ou l'hôte n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/youtube/$$ID$$
||
* $$ID$$ : un ID de vidéo Youtube (https://www.youtube.com/watch?v=mEYyVY9ffDM → mEYyVY9ffDM)
|align='center'|
POST
||
Joue le son de la vidéo, quand c'est possible (certaines vidéos ne fonctionnent pas)
||
* 200 : si la vidéo existe
* 400 : si le vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/url
||
* path : un lien vers un fichier musical
|align='center'|
POST
||
Joue le fichier
||
* 200 : si la fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Indexer (WIP)=
Permet d'avoir des informations sur les travaux d'indexation en cours. Voici un exemple:
* d'identifiant de travail → 5c2e724887be4;
* d'informations sur un travail → {"files":{"directory":"\/opt\/mount\/192.168.1.252-torrent\/\/Best of POP JCF","total":8,"current":[],"processed":8,"remaining":0,"success":[1,2,3,4,5,6,7,8],"failure":[]},"time":{"start":1546547784,"elapsed":1,"end":1546547785},"state":2}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/index/run
||
*vide
|align='center'|
GET
||
Retourne la liste des identifiants des travaux en cours
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info
||
*vide
|align='center'|
GET
||
Récupère la liste des identifiants des travaux disponibles pour consultation
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
GET
||
Récupère les informations liées au travail désigné par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/run/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
DELETE
||
Stop le travail d'indexation désignè par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
DELETE
||
Supprime les informations liées au travail désigné par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]

Music sender api

2019-01-13T11:20:07Z

Tala : /* Share */

=User=
L'objet user est composé comme suit : {"id":"1","pseudo":"tala","email":"tala@tala.com","id_image":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/user
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets utilisateur
||
*200 : si l'objet existe
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
*vide
|align='center'|
GET
||
Retourne un objet utilisateur
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/
||
* pseudo : le pseudo de l'utilisateur
* email : le mail de l'utilisateur
* password : le mot de passe de l'utilisateur
* image : l'identifiant de l'image
|align='center'|
POST
||
Crée un nouvel utilisateur et renvoie son identifiant
||
*201 : si la création réussi avec en réponse l'identifiant (eg. {"id":1} )
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/email/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
* email : le mail de l'utilisateur
|align='center'|
PUT
||
Modifie l'email du compte
||
*200 : si la modification réussie
*400 : si une erreur survient
*404 : si l'utilisateur n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/password/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
* password : le nouveau mot de passe utilisateur
|align='center'|
PUT
||
Modifie le mot de passe du compte
||
*200 : si la modification réussie
*400 : si une erreur survient
*404 : si l'utilisateur n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/$$ID$$
*$$ID$$ : un id de d'artiste
||
*vide
|align='center'|
DELETE
||
Efface l'utilisateur
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
*400 : si une erreur survient
||
[[Fichier:implemented_red_cross.png|center|40px]]
|}

=Genre=
L'objet genre est composé comme suit : {"id": "1", "name": "Electro-Jazz"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/genre
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets genre
||
*200 : si l'objet existe
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
GET
||
Retourne un objet genre
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un genre
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets genre
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre
||
*genre : le nom du genre
|align='center'|
POST
||
Créé un nouvel objet genre
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*genre : le nom du genre
|align='center'|
PUT
||
Modifie le nom du genre
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
DELETE
||
Efface le genre
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Artist=
L'objet artiste est composé comme suit : {"id":"84","name":"Yolanda Be Cool & Dcup","id_image":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/artist
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets artiste
||
*200 : si l'objet existe
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
GET
||
Retourne un objet artiste
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets artiste
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist
||
*name : le nom de l'artist
*image : l'identifiant d'une image (optionnel)
|align='center'|
POST
||
Créé un nouvel objet artiste
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/name/$$ID$$
*$$ID$$ : un id d'artiste
||
*name: le nom de l’artiste
|align='center'|
PUT
||
Modifie le nom de l'artiste
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/image/$$ID$$
*$$ID$$ : un id d'artiste
||
*image: l'identifiant de l'image
|align='center'|
PUT
||
Modifie l'image de l'artiste
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
DELETE
||
Efface l'artiste
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Album=
L'objet album est composé comme suit : {"id":"1","album":"Electro Swing Collection 1","coverId":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/album
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
GET
||
Retourne un objet album
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/artist/$$ID$$
*$$ID$$ : l'identifiant d'un artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/genre/$$ID$$
*$$ID$$ : l'identifiant d'un genre
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'album
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album
||
*name : le nom de l'album
*image : l'identifiant d'une image (optionnel)
|align='center'|
POST
||
Créé un nouvel objet album
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/name/$$ID$$
*$$ID$$ : un id d'album
||
*name: le nom de l’album
|align='center'|
PUT
||
Modifie le nom de l'album
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/image/$$ID$$
*$$ID$$ : un id d'album
||
*image: l'identifiant de l'image
|align='center'|
PUT
||
Modifie l'image de l'album
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
DELETE
||
Efface l'album
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Music=
L'objet musique est composé comme suit : {"id":"1","title":"All Night","artists":["1"],"genres":["1"],"bitrate":"128","hit":"4","duration":"163","id_image":"1"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/music/info/$$ID$$
* $$ID$$ : un identifiant de musique
||
*vide
|align='center'|
GET
||
Retourne un objet musique au format Json
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/content/$$ID$$
* $$ID$$ : un identifiant de musique
||
*vide
|align='center'|
GET
||
Retourne le contenu de la musique (fichier son)<br>
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/album/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objet musiques au format Json appartenant à l'album associé à l'identifiant
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/artist/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objet musiques au format Json dont le créateur est l'artiste associé à l'identifiant
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Image=
L'objet image est composé comme suit : {"id": "1", "content": "/9j/4B4…T0+7RRW/2Q==","mime":"image\jpeg","hash":"0aebaad7…4f265bd"} }
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/images
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets image
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image/info/$$ID$$
*$$ID$$ : un id d'image
||
*vide
|align='center'|
GET
||
Retourne un objet image
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image/content/$$ID$$
*$$ID$$ : un id d'image
||
*vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image
||
*content : le contenu du fichier image
|align='center'|
POST
||
Créé un nouvel objet image
||
*200 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_red_cross.png|center|40px]]
|-
||
/api/image/$$ID$$
*$$ID$$ : un id d'image
||
*content : le contenu du fichier image
|align='center'|
PUT
||
Modifie l'image
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_red_cross.png|center|40px]]
|-
||
/api/image/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
DELETE
||
Efface l'image
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Device=
L'objet périphérique est composé comme suit : {"name":"\/dev\/sda1","label":"MUSIC","size":"7.2 GiB","UUID":"84B9-A853","fstype":"vfat"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/device
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les périphériques
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/list/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
** extension : un filtre par extension de fichier (optionnel)
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste récursive des fichiers
||
*200 : si l'UUID existe
*400 : si l'UUID n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/explore/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
** extension : un filtre par extension de fichier (optionnel)
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste des fichiers et dossiers:

{"directories":["Pop","Rock"],"files":["Gala - Freed From Desire.mp3","13)Jacques Your Body (Make Me Sweat)(Jcf Pitch Edit).mp3"]}
||
*200 : si l'UUID existe
*400 : si l'UUID n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/content/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
||
* vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/tag/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
||
* vide
|align='center'|
GET
||
Retourne un tableau contenant les tags du ou des fichiers présent dans le répertoire
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/size/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
||
* vide
|align='center'|
GET
||
Retourne la taille du fichiers ou répertoire
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mounted
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des périphériques montés
||
*200 : si aucune erreur
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/umounted
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des périphériques démontés
||
*200 : si aucune erreur
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mount/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* vide
|align='center'|
POST
||
Monte le périphérique sur le système
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/enable/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* vide
|align='center'|
POST
||
Active le montage du périphérique au démarrage du système
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/index/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
||
* vide
|align='center'|
POST
||
Index le répertoire ou le fichier désigné par le paramètre path
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mount/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*vide
|align='center'|
DELETE
||
Démonte le périphérique du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/enable/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*vide
|align='center'|
DELETE
||
Désactive le montage du périphérique au démarrage du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Share=
L'objet partage est composé comme suit : {"host":"hades","share":"downloads","login":"nobody"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/share
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les partages montés
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/list/$$HOST$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste des partages disponibles sur l'hôte
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/list/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
** extension : filtre à appliquer sur les fichiers (optionnel)
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste récursive de tous les fichiers disponibles sur le partage

Attention, l'appel peut être long, surtout lorsque les partages contiennent beaucoup de fichiers
||
* 200 : si le partage existe
* 400 : si le partage n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/explore/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
** extension : filtre à appliquer sur les fichiers (optionnel)
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des fichiers
||
*200 : si le partage existe
*400 : si le partage n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/content/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
||
*vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/tag/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
||
*vide
|align='center'|
GET
||
Retourne un tableau contenant les tags du ou des fichiers présent dans le répertoire
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/size/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
||
*vide
|align='center'|
GET
||
Retourne la taille du fichiers ou répertoire
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* login : le login à utiliser (optionnel)
* password : le mot de passe associé (optionnel)
|align='center'|
POST
||
Monte le partage sur le système. Si aucun couple d'authentification n'est fourni, ''nobody'' sera utilisé
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/index/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
||
*vide
|align='center'|
POST
||
Index le répertoire ou le fichier désigné par le paramètre path
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
*vide
|align='center'|
DELETE
||
Démonte le partage du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

= Youtube =
Permet de récupérer des informations sur les vidéo Youtube
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/youtube/info/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère des informations sur la vidéo Youtube. Voici un exemple:

{

"url":"https:\/\/www.youtube.com\/watch?v=eVGrSCrRiy8",

"cover":"https:\/\/i.ytimg.com\/vi\/eVGrSCrRiy8\/maxresdefault.jpg",

"author":"ElectroDanceMixes",

"title":"FESTIVAL MIX - Best EDM & Electro House Dance Party Mix 2018",

"id":"eVGrSCrRiy8",

"videos":["..."]

}
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/youtube/cover/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère la ''pochette'' de la vidéo
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/youtube/listen/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère le contenu de la vidéo
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Player=
Joue la musique sur la carte son du Pi (intégration VLC)
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/player/pause
||
*vide
|align='center'|
GET
||
Met en pause la music
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/stop
||
*vide
|align='center'|
GET
||
Stop la lecture
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/volume/$$PERCENT$$
*$$PERCENT$$ : le volume en poucentage
||
*vide
|align='center'|
GET
||
Règle le volume du lecteur
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/device/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*path : un chemin sur le périphérique
|align='center'|
POST
||
Joue le fichier désigné par ''path'' sur le périphérique ''UUID''
||
*200 : si le fichier et le périphérique existent
*400 : si le fichier ou le périphérique n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
*path : un chemin sur le partage
|align='center'|
POST
||
Joue le fichier désigné par ''path'' sur le partage ''SHARE'' sur l'hôte ''HOST''
||
*200 : si le fichier, le partage et l'hôte existent
*400 : si le fichier, le partage ou l'hôte n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/youtube/$$ID$$
||
* $$ID$$ : un ID de vidéo Youtube (https://www.youtube.com/watch?v=mEYyVY9ffDM → mEYyVY9ffDM)
|align='center'|
POST
||
Joue le son de la vidéo, quand c'est possible (certaines vidéos ne fonctionnent pas)
||
* 200 : si la vidéo existe
* 400 : si le vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/url
||
* path : un lien vers un fichier musical
|align='center'|
POST
||
Joue le fichier
||
* 200 : si la fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Indexer (WIP)=
Permet d'avoir des informations sur les travaux d'indexation en cours. Voici un exemple:
* d'identifiant de travail → 5c2e724887be4;
* d'informations sur un travail → {"files":{"directory":"\/opt\/mount\/192.168.1.252-torrent\/\/Best of POP JCF","total":8,"current":[],"processed":8,"remaining":0,"success":[1,2,3,4,5,6,7,8],"failure":[]},"time":{"start":1546547784,"elapsed":1,"end":1546547785},"state":2}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/index/run
||
*vide
|align='center'|
GET
||
Retourne la liste des identifiants des travaux en cours
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info
||
*vide
|align='center'|
GET
||
Récupère la liste des identifiants des travaux disponibles pour consultation
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
GET
||
Récupère les informations liées au travail désigné par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/run/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
DELETE
||
Stop le travail d'indexation désignè par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
DELETE
||
Supprime les informations liées au travail désigné par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]

Music sender api

2019-01-13T11:16:48Z

Tala : /* Device */

=User=
L'objet user est composé comme suit : {"id":"1","pseudo":"tala","email":"tala@tala.com","id_image":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/user
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets utilisateur
||
*200 : si l'objet existe
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
*vide
|align='center'|
GET
||
Retourne un objet utilisateur
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/
||
* pseudo : le pseudo de l'utilisateur
* email : le mail de l'utilisateur
* password : le mot de passe de l'utilisateur
* image : l'identifiant de l'image
|align='center'|
POST
||
Crée un nouvel utilisateur et renvoie son identifiant
||
*201 : si la création réussi avec en réponse l'identifiant (eg. {"id":1} )
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/email/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
* email : le mail de l'utilisateur
|align='center'|
PUT
||
Modifie l'email du compte
||
*200 : si la modification réussie
*400 : si une erreur survient
*404 : si l'utilisateur n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/password/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
* password : le nouveau mot de passe utilisateur
|align='center'|
PUT
||
Modifie le mot de passe du compte
||
*200 : si la modification réussie
*400 : si une erreur survient
*404 : si l'utilisateur n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/$$ID$$
*$$ID$$ : un id de d'artiste
||
*vide
|align='center'|
DELETE
||
Efface l'utilisateur
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
*400 : si une erreur survient
||
[[Fichier:implemented_red_cross.png|center|40px]]
|}

=Genre=
L'objet genre est composé comme suit : {"id": "1", "name": "Electro-Jazz"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/genre
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets genre
||
*200 : si l'objet existe
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
GET
||
Retourne un objet genre
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un genre
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets genre
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre
||
*genre : le nom du genre
|align='center'|
POST
||
Créé un nouvel objet genre
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*genre : le nom du genre
|align='center'|
PUT
||
Modifie le nom du genre
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
DELETE
||
Efface le genre
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Artist=
L'objet artiste est composé comme suit : {"id":"84","name":"Yolanda Be Cool & Dcup","id_image":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/artist
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets artiste
||
*200 : si l'objet existe
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
GET
||
Retourne un objet artiste
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets artiste
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist
||
*name : le nom de l'artist
*image : l'identifiant d'une image (optionnel)
|align='center'|
POST
||
Créé un nouvel objet artiste
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/name/$$ID$$
*$$ID$$ : un id d'artiste
||
*name: le nom de l’artiste
|align='center'|
PUT
||
Modifie le nom de l'artiste
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/image/$$ID$$
*$$ID$$ : un id d'artiste
||
*image: l'identifiant de l'image
|align='center'|
PUT
||
Modifie l'image de l'artiste
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
DELETE
||
Efface l'artiste
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Album=
L'objet album est composé comme suit : {"id":"1","album":"Electro Swing Collection 1","coverId":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/album
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
GET
||
Retourne un objet album
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/artist/$$ID$$
*$$ID$$ : l'identifiant d'un artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/genre/$$ID$$
*$$ID$$ : l'identifiant d'un genre
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'album
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album
||
*name : le nom de l'album
*image : l'identifiant d'une image (optionnel)
|align='center'|
POST
||
Créé un nouvel objet album
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/name/$$ID$$
*$$ID$$ : un id d'album
||
*name: le nom de l’album
|align='center'|
PUT
||
Modifie le nom de l'album
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/image/$$ID$$
*$$ID$$ : un id d'album
||
*image: l'identifiant de l'image
|align='center'|
PUT
||
Modifie l'image de l'album
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
DELETE
||
Efface l'album
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Music=
L'objet musique est composé comme suit : {"id":"1","title":"All Night","artists":["1"],"genres":["1"],"bitrate":"128","hit":"4","duration":"163","id_image":"1"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/music/info/$$ID$$
* $$ID$$ : un identifiant de musique
||
*vide
|align='center'|
GET
||
Retourne un objet musique au format Json
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/content/$$ID$$
* $$ID$$ : un identifiant de musique
||
*vide
|align='center'|
GET
||
Retourne le contenu de la musique (fichier son)<br>
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/album/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objet musiques au format Json appartenant à l'album associé à l'identifiant
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/artist/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objet musiques au format Json dont le créateur est l'artiste associé à l'identifiant
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Image=
L'objet image est composé comme suit : {"id": "1", "content": "/9j/4B4…T0+7RRW/2Q==","mime":"image\jpeg","hash":"0aebaad7…4f265bd"} }
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/images
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets image
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image/info/$$ID$$
*$$ID$$ : un id d'image
||
*vide
|align='center'|
GET
||
Retourne un objet image
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image/content/$$ID$$
*$$ID$$ : un id d'image
||
*vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image
||
*content : le contenu du fichier image
|align='center'|
POST
||
Créé un nouvel objet image
||
*200 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_red_cross.png|center|40px]]
|-
||
/api/image/$$ID$$
*$$ID$$ : un id d'image
||
*content : le contenu du fichier image
|align='center'|
PUT
||
Modifie l'image
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_red_cross.png|center|40px]]
|-
||
/api/image/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
DELETE
||
Efface l'image
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Device=
L'objet périphérique est composé comme suit : {"name":"\/dev\/sda1","label":"MUSIC","size":"7.2 GiB","UUID":"84B9-A853","fstype":"vfat"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/device
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les périphériques
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/list/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
** extension : un filtre par extension de fichier (optionnel)
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste récursive des fichiers
||
*200 : si l'UUID existe
*400 : si l'UUID n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/explore/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
** extension : un filtre par extension de fichier (optionnel)
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste des fichiers et dossiers:

{"directories":["Pop","Rock"],"files":["Gala - Freed From Desire.mp3","13)Jacques Your Body (Make Me Sweat)(Jcf Pitch Edit).mp3"]}
||
*200 : si l'UUID existe
*400 : si l'UUID n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/content/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
||
* vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/tag/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
||
* vide
|align='center'|
GET
||
Retourne un tableau contenant les tags du ou des fichiers présent dans le répertoire
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/size/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
||
* vide
|align='center'|
GET
||
Retourne la taille du fichiers ou répertoire
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mounted
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des périphériques montés
||
*200 : si aucune erreur
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/umounted
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des périphériques démontés
||
*200 : si aucune erreur
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mount/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* vide
|align='center'|
POST
||
Monte le périphérique sur le système
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/enable/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* vide
|align='center'|
POST
||
Active le montage du périphérique au démarrage du système
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/index/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
||
* vide
|align='center'|
POST
||
Index le répertoire ou le fichier désigné par le paramètre path
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mount/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*vide
|align='center'|
DELETE
||
Démonte le périphérique du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/enable/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*vide
|align='center'|
DELETE
||
Désactive le montage du périphérique au démarrage du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Share=
L'objet partage est composé comme suit : {"host":"hades","share":"downloads","login":"nobody"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/share
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les partages montés
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/list/$$HOST$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste des partages disponibles sur l'hôte
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/list/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
** extension : filtre à appliquer sur les fichiers (optionnel)
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste récursive de tous les fichiers disponibles sur le partage

Attention, l'appel peut être long, surtout lorsque les partages contiennent beaucoup de fichiers
||
* 200 : si le partage existe
* 400 : si le partage n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/explore/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
** extension : filtre à appliquer sur les fichiers (optionnel)
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des fichiers
||
*200 : si le partage existe
*400 : si le partage n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/content/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
||
*vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/tag/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
||
*vide
|align='center'|
GET
||
Retourne un tableau contenant les tags du ou des fichiers présent dans le répertoire
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* login : le login à utiliser (optionnel)
* password : le mot de passe associé (optionnel)
|align='center'|
POST
||
Monte le partage sur le système. Si aucun couple d'authentification n'est fourni, ''nobody'' sera utilisé
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/index/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
||
*vide
|align='center'|
POST
||
Index le répertoire ou le fichier désigné par le paramètre path
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
*vide
|align='center'|
DELETE
||
Démonte le partage du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

= Youtube =
Permet de récupérer des informations sur les vidéo Youtube
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/youtube/info/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère des informations sur la vidéo Youtube. Voici un exemple:

{

"url":"https:\/\/www.youtube.com\/watch?v=eVGrSCrRiy8",

"cover":"https:\/\/i.ytimg.com\/vi\/eVGrSCrRiy8\/maxresdefault.jpg",

"author":"ElectroDanceMixes",

"title":"FESTIVAL MIX - Best EDM & Electro House Dance Party Mix 2018",

"id":"eVGrSCrRiy8",

"videos":["..."]

}
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/youtube/cover/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère la ''pochette'' de la vidéo
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/youtube/listen/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère le contenu de la vidéo
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Player=
Joue la musique sur la carte son du Pi (intégration VLC)
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/player/pause
||
*vide
|align='center'|
GET
||
Met en pause la music
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/stop
||
*vide
|align='center'|
GET
||
Stop la lecture
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/volume/$$PERCENT$$
*$$PERCENT$$ : le volume en poucentage
||
*vide
|align='center'|
GET
||
Règle le volume du lecteur
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/device/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*path : un chemin sur le périphérique
|align='center'|
POST
||
Joue le fichier désigné par ''path'' sur le périphérique ''UUID''
||
*200 : si le fichier et le périphérique existent
*400 : si le fichier ou le périphérique n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
*path : un chemin sur le partage
|align='center'|
POST
||
Joue le fichier désigné par ''path'' sur le partage ''SHARE'' sur l'hôte ''HOST''
||
*200 : si le fichier, le partage et l'hôte existent
*400 : si le fichier, le partage ou l'hôte n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/youtube/$$ID$$
||
* $$ID$$ : un ID de vidéo Youtube (https://www.youtube.com/watch?v=mEYyVY9ffDM → mEYyVY9ffDM)
|align='center'|
POST
||
Joue le son de la vidéo, quand c'est possible (certaines vidéos ne fonctionnent pas)
||
* 200 : si la vidéo existe
* 400 : si le vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/url
||
* path : un lien vers un fichier musical
|align='center'|
POST
||
Joue le fichier
||
* 200 : si la fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Indexer (WIP)=
Permet d'avoir des informations sur les travaux d'indexation en cours. Voici un exemple:
* d'identifiant de travail → 5c2e724887be4;
* d'informations sur un travail → {"files":{"directory":"\/opt\/mount\/192.168.1.252-torrent\/\/Best of POP JCF","total":8,"current":[],"processed":8,"remaining":0,"success":[1,2,3,4,5,6,7,8],"failure":[]},"time":{"start":1546547784,"elapsed":1,"end":1546547785},"state":2}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/index/run
||
*vide
|align='center'|
GET
||
Retourne la liste des identifiants des travaux en cours
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info
||
*vide
|align='center'|
GET
||
Récupère la liste des identifiants des travaux disponibles pour consultation
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
GET
||
Récupère les informations liées au travail désigné par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/run/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
DELETE
||
Stop le travail d'indexation désignè par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
DELETE
||
Supprime les informations liées au travail désigné par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]

Music sender api

2019-01-13T11:15:25Z

Tala : /* Share */

=User=
L'objet user est composé comme suit : {"id":"1","pseudo":"tala","email":"tala@tala.com","id_image":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/user
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets utilisateur
||
*200 : si l'objet existe
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
*vide
|align='center'|
GET
||
Retourne un objet utilisateur
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/
||
* pseudo : le pseudo de l'utilisateur
* email : le mail de l'utilisateur
* password : le mot de passe de l'utilisateur
* image : l'identifiant de l'image
|align='center'|
POST
||
Crée un nouvel utilisateur et renvoie son identifiant
||
*201 : si la création réussi avec en réponse l'identifiant (eg. {"id":1} )
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/email/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
* email : le mail de l'utilisateur
|align='center'|
PUT
||
Modifie l'email du compte
||
*200 : si la modification réussie
*400 : si une erreur survient
*404 : si l'utilisateur n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/password/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
* password : le nouveau mot de passe utilisateur
|align='center'|
PUT
||
Modifie le mot de passe du compte
||
*200 : si la modification réussie
*400 : si une erreur survient
*404 : si l'utilisateur n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/$$ID$$
*$$ID$$ : un id de d'artiste
||
*vide
|align='center'|
DELETE
||
Efface l'utilisateur
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
*400 : si une erreur survient
||
[[Fichier:implemented_red_cross.png|center|40px]]
|}

=Genre=
L'objet genre est composé comme suit : {"id": "1", "name": "Electro-Jazz"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/genre
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets genre
||
*200 : si l'objet existe
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
GET
||
Retourne un objet genre
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un genre
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets genre
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre
||
*genre : le nom du genre
|align='center'|
POST
||
Créé un nouvel objet genre
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*genre : le nom du genre
|align='center'|
PUT
||
Modifie le nom du genre
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
DELETE
||
Efface le genre
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Artist=
L'objet artiste est composé comme suit : {"id":"84","name":"Yolanda Be Cool & Dcup","id_image":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/artist
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets artiste
||
*200 : si l'objet existe
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
GET
||
Retourne un objet artiste
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets artiste
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist
||
*name : le nom de l'artist
*image : l'identifiant d'une image (optionnel)
|align='center'|
POST
||
Créé un nouvel objet artiste
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/name/$$ID$$
*$$ID$$ : un id d'artiste
||
*name: le nom de l’artiste
|align='center'|
PUT
||
Modifie le nom de l'artiste
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/image/$$ID$$
*$$ID$$ : un id d'artiste
||
*image: l'identifiant de l'image
|align='center'|
PUT
||
Modifie l'image de l'artiste
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
DELETE
||
Efface l'artiste
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Album=
L'objet album est composé comme suit : {"id":"1","album":"Electro Swing Collection 1","coverId":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/album
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
GET
||
Retourne un objet album
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/artist/$$ID$$
*$$ID$$ : l'identifiant d'un artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/genre/$$ID$$
*$$ID$$ : l'identifiant d'un genre
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'album
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album
||
*name : le nom de l'album
*image : l'identifiant d'une image (optionnel)
|align='center'|
POST
||
Créé un nouvel objet album
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/name/$$ID$$
*$$ID$$ : un id d'album
||
*name: le nom de l’album
|align='center'|
PUT
||
Modifie le nom de l'album
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/image/$$ID$$
*$$ID$$ : un id d'album
||
*image: l'identifiant de l'image
|align='center'|
PUT
||
Modifie l'image de l'album
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
DELETE
||
Efface l'album
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Music=
L'objet musique est composé comme suit : {"id":"1","title":"All Night","artists":["1"],"genres":["1"],"bitrate":"128","hit":"4","duration":"163","id_image":"1"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/music/info/$$ID$$
* $$ID$$ : un identifiant de musique
||
*vide
|align='center'|
GET
||
Retourne un objet musique au format Json
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/content/$$ID$$
* $$ID$$ : un identifiant de musique
||
*vide
|align='center'|
GET
||
Retourne le contenu de la musique (fichier son)<br>
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/album/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objet musiques au format Json appartenant à l'album associé à l'identifiant
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/artist/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objet musiques au format Json dont le créateur est l'artiste associé à l'identifiant
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Image=
L'objet image est composé comme suit : {"id": "1", "content": "/9j/4B4…T0+7RRW/2Q==","mime":"image\jpeg","hash":"0aebaad7…4f265bd"} }
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/images
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets image
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image/info/$$ID$$
*$$ID$$ : un id d'image
||
*vide
|align='center'|
GET
||
Retourne un objet image
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image/content/$$ID$$
*$$ID$$ : un id d'image
||
*vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image
||
*content : le contenu du fichier image
|align='center'|
POST
||
Créé un nouvel objet image
||
*200 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_red_cross.png|center|40px]]
|-
||
/api/image/$$ID$$
*$$ID$$ : un id d'image
||
*content : le contenu du fichier image
|align='center'|
PUT
||
Modifie l'image
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_red_cross.png|center|40px]]
|-
||
/api/image/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
DELETE
||
Efface l'image
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Device=
L'objet périphérique est composé comme suit : {"name":"\/dev\/sda1","label":"MUSIC","size":"7.2 GiB","UUID":"84B9-A853","fstype":"vfat"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/device
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les périphériques
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/list/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
** extension : un filtre par extension de fichier (optionnel)
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste récursive des fichiers
||
*200 : si l'UUID existe
*400 : si l'UUID n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/explore/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
** extension : un filtre par extension de fichier (optionnel)
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste des fichiers et dossiers:

{"directories":["Pop","Rock"],"files":["Gala - Freed From Desire.mp3","13)Jacques Your Body (Make Me Sweat)(Jcf Pitch Edit).mp3"]}
||
*200 : si l'UUID existe
*400 : si l'UUID n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/content/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
||
* vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/tag/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
||
* vide
|align='center'|
GET
||
Retourne un tableau contenant les tags du ou des fichiers présent dans le répertoire
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mounted
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des périphériques montés
||
*200 : si aucune erreur
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/umounted
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des périphériques démontés
||
*200 : si aucune erreur
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mount/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* vide
|align='center'|
POST
||
Monte le périphérique sur le système
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/enable/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* vide
|align='center'|
POST
||
Active le montage du périphérique au démarrage du système
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/index/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
||
* vide
|align='center'|
POST
||
Index le répertoire ou le fichier désigné par le paramètre path
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mount/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*vide
|align='center'|
DELETE
||
Démonte le périphérique du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/enable/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*vide
|align='center'|
DELETE
||
Désactive le montage du périphérique au démarrage du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Share=
L'objet partage est composé comme suit : {"host":"hades","share":"downloads","login":"nobody"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/share
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les partages montés
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/list/$$HOST$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste des partages disponibles sur l'hôte
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/list/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
** extension : filtre à appliquer sur les fichiers (optionnel)
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste récursive de tous les fichiers disponibles sur le partage

Attention, l'appel peut être long, surtout lorsque les partages contiennent beaucoup de fichiers
||
* 200 : si le partage existe
* 400 : si le partage n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/explore/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
** extension : filtre à appliquer sur les fichiers (optionnel)
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des fichiers
||
*200 : si le partage existe
*400 : si le partage n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/content/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
||
*vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/tag/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
||
*vide
|align='center'|
GET
||
Retourne un tableau contenant les tags du ou des fichiers présent dans le répertoire
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* login : le login à utiliser (optionnel)
* password : le mot de passe associé (optionnel)
|align='center'|
POST
||
Monte le partage sur le système. Si aucun couple d'authentification n'est fourni, ''nobody'' sera utilisé
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/index/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
* paramètre(s):
** path : un chemin sur le partage
||
*vide
|align='center'|
POST
||
Index le répertoire ou le fichier désigné par le paramètre path
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
*vide
|align='center'|
DELETE
||
Démonte le partage du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

= Youtube =
Permet de récupérer des informations sur les vidéo Youtube
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/youtube/info/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère des informations sur la vidéo Youtube. Voici un exemple:

{

"url":"https:\/\/www.youtube.com\/watch?v=eVGrSCrRiy8",

"cover":"https:\/\/i.ytimg.com\/vi\/eVGrSCrRiy8\/maxresdefault.jpg",

"author":"ElectroDanceMixes",

"title":"FESTIVAL MIX - Best EDM & Electro House Dance Party Mix 2018",

"id":"eVGrSCrRiy8",

"videos":["..."]

}
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/youtube/cover/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère la ''pochette'' de la vidéo
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/youtube/listen/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère le contenu de la vidéo
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Player=
Joue la musique sur la carte son du Pi (intégration VLC)
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/player/pause
||
*vide
|align='center'|
GET
||
Met en pause la music
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/stop
||
*vide
|align='center'|
GET
||
Stop la lecture
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/volume/$$PERCENT$$
*$$PERCENT$$ : le volume en poucentage
||
*vide
|align='center'|
GET
||
Règle le volume du lecteur
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/device/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*path : un chemin sur le périphérique
|align='center'|
POST
||
Joue le fichier désigné par ''path'' sur le périphérique ''UUID''
||
*200 : si le fichier et le périphérique existent
*400 : si le fichier ou le périphérique n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
*path : un chemin sur le partage
|align='center'|
POST
||
Joue le fichier désigné par ''path'' sur le partage ''SHARE'' sur l'hôte ''HOST''
||
*200 : si le fichier, le partage et l'hôte existent
*400 : si le fichier, le partage ou l'hôte n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/youtube/$$ID$$
||
* $$ID$$ : un ID de vidéo Youtube (https://www.youtube.com/watch?v=mEYyVY9ffDM → mEYyVY9ffDM)
|align='center'|
POST
||
Joue le son de la vidéo, quand c'est possible (certaines vidéos ne fonctionnent pas)
||
* 200 : si la vidéo existe
* 400 : si le vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/url
||
* path : un lien vers un fichier musical
|align='center'|
POST
||
Joue le fichier
||
* 200 : si la fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Indexer (WIP)=
Permet d'avoir des informations sur les travaux d'indexation en cours. Voici un exemple:
* d'identifiant de travail → 5c2e724887be4;
* d'informations sur un travail → {"files":{"directory":"\/opt\/mount\/192.168.1.252-torrent\/\/Best of POP JCF","total":8,"current":[],"processed":8,"remaining":0,"success":[1,2,3,4,5,6,7,8],"failure":[]},"time":{"start":1546547784,"elapsed":1,"end":1546547785},"state":2}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/index/run
||
*vide
|align='center'|
GET
||
Retourne la liste des identifiants des travaux en cours
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info
||
*vide
|align='center'|
GET
||
Récupère la liste des identifiants des travaux disponibles pour consultation
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
GET
||
Récupère les informations liées au travail désigné par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/run/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
DELETE
||
Stop le travail d'indexation désignè par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
DELETE
||
Supprime les informations liées au travail désigné par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]

Music sender api

2019-01-13T11:12:59Z

Tala : /* Device */

=User=
L'objet user est composé comme suit : {"id":"1","pseudo":"tala","email":"tala@tala.com","id_image":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/user
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets utilisateur
||
*200 : si l'objet existe
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
*vide
|align='center'|
GET
||
Retourne un objet utilisateur
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/
||
* pseudo : le pseudo de l'utilisateur
* email : le mail de l'utilisateur
* password : le mot de passe de l'utilisateur
* image : l'identifiant de l'image
|align='center'|
POST
||
Crée un nouvel utilisateur et renvoie son identifiant
||
*201 : si la création réussi avec en réponse l'identifiant (eg. {"id":1} )
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/email/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
* email : le mail de l'utilisateur
|align='center'|
PUT
||
Modifie l'email du compte
||
*200 : si la modification réussie
*400 : si une erreur survient
*404 : si l'utilisateur n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/password/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
* password : le nouveau mot de passe utilisateur
|align='center'|
PUT
||
Modifie le mot de passe du compte
||
*200 : si la modification réussie
*400 : si une erreur survient
*404 : si l'utilisateur n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/$$ID$$
*$$ID$$ : un id de d'artiste
||
*vide
|align='center'|
DELETE
||
Efface l'utilisateur
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
*400 : si une erreur survient
||
[[Fichier:implemented_red_cross.png|center|40px]]
|}

=Genre=
L'objet genre est composé comme suit : {"id": "1", "name": "Electro-Jazz"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/genre
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets genre
||
*200 : si l'objet existe
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
GET
||
Retourne un objet genre
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un genre
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets genre
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre
||
*genre : le nom du genre
|align='center'|
POST
||
Créé un nouvel objet genre
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*genre : le nom du genre
|align='center'|
PUT
||
Modifie le nom du genre
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
DELETE
||
Efface le genre
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Artist=
L'objet artiste est composé comme suit : {"id":"84","name":"Yolanda Be Cool & Dcup","id_image":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/artist
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets artiste
||
*200 : si l'objet existe
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
GET
||
Retourne un objet artiste
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets artiste
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist
||
*name : le nom de l'artist
*image : l'identifiant d'une image (optionnel)
|align='center'|
POST
||
Créé un nouvel objet artiste
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/name/$$ID$$
*$$ID$$ : un id d'artiste
||
*name: le nom de l’artiste
|align='center'|
PUT
||
Modifie le nom de l'artiste
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/image/$$ID$$
*$$ID$$ : un id d'artiste
||
*image: l'identifiant de l'image
|align='center'|
PUT
||
Modifie l'image de l'artiste
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
DELETE
||
Efface l'artiste
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Album=
L'objet album est composé comme suit : {"id":"1","album":"Electro Swing Collection 1","coverId":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/album
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
GET
||
Retourne un objet album
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/artist/$$ID$$
*$$ID$$ : l'identifiant d'un artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/genre/$$ID$$
*$$ID$$ : l'identifiant d'un genre
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'album
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album
||
*name : le nom de l'album
*image : l'identifiant d'une image (optionnel)
|align='center'|
POST
||
Créé un nouvel objet album
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/name/$$ID$$
*$$ID$$ : un id d'album
||
*name: le nom de l’album
|align='center'|
PUT
||
Modifie le nom de l'album
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/image/$$ID$$
*$$ID$$ : un id d'album
||
*image: l'identifiant de l'image
|align='center'|
PUT
||
Modifie l'image de l'album
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
DELETE
||
Efface l'album
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Music=
L'objet musique est composé comme suit : {"id":"1","title":"All Night","artists":["1"],"genres":["1"],"bitrate":"128","hit":"4","duration":"163","id_image":"1"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/music/info/$$ID$$
* $$ID$$ : un identifiant de musique
||
*vide
|align='center'|
GET
||
Retourne un objet musique au format Json
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/content/$$ID$$
* $$ID$$ : un identifiant de musique
||
*vide
|align='center'|
GET
||
Retourne le contenu de la musique (fichier son)<br>
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/album/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objet musiques au format Json appartenant à l'album associé à l'identifiant
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/artist/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objet musiques au format Json dont le créateur est l'artiste associé à l'identifiant
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Image=
L'objet image est composé comme suit : {"id": "1", "content": "/9j/4B4…T0+7RRW/2Q==","mime":"image\jpeg","hash":"0aebaad7…4f265bd"} }
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/images
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets image
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image/info/$$ID$$
*$$ID$$ : un id d'image
||
*vide
|align='center'|
GET
||
Retourne un objet image
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image/content/$$ID$$
*$$ID$$ : un id d'image
||
*vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image
||
*content : le contenu du fichier image
|align='center'|
POST
||
Créé un nouvel objet image
||
*200 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_red_cross.png|center|40px]]
|-
||
/api/image/$$ID$$
*$$ID$$ : un id d'image
||
*content : le contenu du fichier image
|align='center'|
PUT
||
Modifie l'image
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_red_cross.png|center|40px]]
|-
||
/api/image/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
DELETE
||
Efface l'image
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Device=
L'objet périphérique est composé comme suit : {"name":"\/dev\/sda1","label":"MUSIC","size":"7.2 GiB","UUID":"84B9-A853","fstype":"vfat"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/device
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les périphériques
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/list/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
** extension : un filtre par extension de fichier (optionnel)
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste récursive des fichiers
||
*200 : si l'UUID existe
*400 : si l'UUID n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/explore/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
** extension : un filtre par extension de fichier (optionnel)
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste des fichiers et dossiers:

{"directories":["Pop","Rock"],"files":["Gala - Freed From Desire.mp3","13)Jacques Your Body (Make Me Sweat)(Jcf Pitch Edit).mp3"]}
||
*200 : si l'UUID existe
*400 : si l'UUID n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/content/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
||
* vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/tag/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
||
* vide
|align='center'|
GET
||
Retourne un tableau contenant les tags du ou des fichiers présent dans le répertoire
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mounted
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des périphériques montés
||
*200 : si aucune erreur
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/umounted
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des périphériques démontés
||
*200 : si aucune erreur
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mount/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* vide
|align='center'|
POST
||
Monte le périphérique sur le système
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/enable/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* vide
|align='center'|
POST
||
Active le montage du périphérique au démarrage du système
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/index/$$UUID$$
*$$UUID$$ : un UUID de périphérique
* paramètre(s):
** path : un chemin sur le périphérique
||
* vide
|align='center'|
POST
||
Index le répertoire ou le fichier désigné par le paramètre path
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mount/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*vide
|align='center'|
DELETE
||
Démonte le périphérique du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/enable/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*vide
|align='center'|
DELETE
||
Désactive le montage du périphérique au démarrage du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Share=
L'objet partage est composé comme suit : {"host":"hades","share":"downloads","login":"nobody"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/share
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les partages montés
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/list/$$HOST$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste des partages disponibles sur l'hôte
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/list/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un chemin sur le partage
* extension : filtre à appliquer sur les fichiers (optionnel)
|align='center'|
GET
||
Retourne un tableau avec la liste récursive de tous les fichiers disponibles sur le partage

Attention, l'appel peut être long, surtout lorsque les partages contiennent beaucoup de fichiers
||
* 200 : si le partage existe
* 400 : si le partage n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/explore/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un répertoire sur le partage
* extension : un filtre par extension de fichier (optionnel)
|align='center'|
GET
||
Retourne un tableau avec la liste des fichiers
||
*200 : si le partage existe
*400 : si le partage n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/content/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un chemin sur le partage
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/tag/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un chemin sur le partage
|align='center'|
GET
||
Retourne un tableau contenant les tags du ou des fichiers présent dans le répertoire
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* login : le login à utiliser (optionnel)
* password : le mot de passe associé (optionnel)
|align='center'|
POST
||
Monte le partage sur le système. Si aucun couple d'authentification n'est fourni, ''nobody'' sera utilisé
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/index/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un chemin sur le partage
|align='center'|
POST
||
Index le répertoire ou le fichier désigné par le paramètre path
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
|align='center'|
DELETE
||
Démonte le partage du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

= Youtube =
Permet de récupérer des informations sur les vidéo Youtube
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/youtube/info/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère des informations sur la vidéo Youtube. Voici un exemple:

{

"url":"https:\/\/www.youtube.com\/watch?v=eVGrSCrRiy8",

"cover":"https:\/\/i.ytimg.com\/vi\/eVGrSCrRiy8\/maxresdefault.jpg",

"author":"ElectroDanceMixes",

"title":"FESTIVAL MIX - Best EDM & Electro House Dance Party Mix 2018",

"id":"eVGrSCrRiy8",

"videos":["..."]

}
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/youtube/cover/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère la ''pochette'' de la vidéo
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/youtube/listen/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère le contenu de la vidéo
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Player=
Joue la musique sur la carte son du Pi (intégration VLC)
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/player/pause
||
*vide
|align='center'|
GET
||
Met en pause la music
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/stop
||
*vide
|align='center'|
GET
||
Stop la lecture
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/volume/$$PERCENT$$
*$$PERCENT$$ : le volume en poucentage
||
*vide
|align='center'|
GET
||
Règle le volume du lecteur
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/device/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*path : un chemin sur le périphérique
|align='center'|
POST
||
Joue le fichier désigné par ''path'' sur le périphérique ''UUID''
||
*200 : si le fichier et le périphérique existent
*400 : si le fichier ou le périphérique n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
*path : un chemin sur le partage
|align='center'|
POST
||
Joue le fichier désigné par ''path'' sur le partage ''SHARE'' sur l'hôte ''HOST''
||
*200 : si le fichier, le partage et l'hôte existent
*400 : si le fichier, le partage ou l'hôte n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/youtube/$$ID$$
||
* $$ID$$ : un ID de vidéo Youtube (https://www.youtube.com/watch?v=mEYyVY9ffDM → mEYyVY9ffDM)
|align='center'|
POST
||
Joue le son de la vidéo, quand c'est possible (certaines vidéos ne fonctionnent pas)
||
* 200 : si la vidéo existe
* 400 : si le vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/url
||
* path : un lien vers un fichier musical
|align='center'|
POST
||
Joue le fichier
||
* 200 : si la fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Indexer (WIP)=
Permet d'avoir des informations sur les travaux d'indexation en cours. Voici un exemple:
* d'identifiant de travail → 5c2e724887be4;
* d'informations sur un travail → {"files":{"directory":"\/opt\/mount\/192.168.1.252-torrent\/\/Best of POP JCF","total":8,"current":[],"processed":8,"remaining":0,"success":[1,2,3,4,5,6,7,8],"failure":[]},"time":{"start":1546547784,"elapsed":1,"end":1546547785},"state":2}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/index/run
||
*vide
|align='center'|
GET
||
Retourne la liste des identifiants des travaux en cours
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info
||
*vide
|align='center'|
GET
||
Récupère la liste des identifiants des travaux disponibles pour consultation
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
GET
||
Récupère les informations liées au travail désigné par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/run/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
DELETE
||
Stop le travail d'indexation désignè par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
DELETE
||
Supprime les informations liées au travail désigné par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]

Music sender api

2019-01-03T23:30:00Z

Tala : /* Player */

=User=
L'objet user est composé comme suit : {"id":"1","pseudo":"tala","email":"tala@tala.com","id_image":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/user
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets utilisateur
||
*200 : si l'objet existe
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
*vide
|align='center'|
GET
||
Retourne un objet utilisateur
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/
||
* pseudo : le pseudo de l'utilisateur
* email : le mail de l'utilisateur
* password : le mot de passe de l'utilisateur
* image : l'identifiant de l'image
|align='center'|
POST
||
Crée un nouvel utilisateur et renvoie son identifiant
||
*201 : si la création réussi avec en réponse l'identifiant (eg. {"id":1} )
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/email/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
* email : le mail de l'utilisateur
|align='center'|
PUT
||
Modifie l'email du compte
||
*200 : si la modification réussie
*400 : si une erreur survient
*404 : si l'utilisateur n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/password/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
* password : le nouveau mot de passe utilisateur
|align='center'|
PUT
||
Modifie le mot de passe du compte
||
*200 : si la modification réussie
*400 : si une erreur survient
*404 : si l'utilisateur n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/$$ID$$
*$$ID$$ : un id de d'artiste
||
*vide
|align='center'|
DELETE
||
Efface l'utilisateur
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
*400 : si une erreur survient
||
[[Fichier:implemented_red_cross.png|center|40px]]
|}

=Genre=
L'objet genre est composé comme suit : {"id": "1", "name": "Electro-Jazz"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/genre
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets genre
||
*200 : si l'objet existe
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
GET
||
Retourne un objet genre
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un genre
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets genre
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre
||
*genre : le nom du genre
|align='center'|
POST
||
Créé un nouvel objet genre
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*genre : le nom du genre
|align='center'|
PUT
||
Modifie le nom du genre
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
DELETE
||
Efface le genre
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Artist=
L'objet artiste est composé comme suit : {"id":"84","name":"Yolanda Be Cool & Dcup","id_image":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/artist
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets artiste
||
*200 : si l'objet existe
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
GET
||
Retourne un objet artiste
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets artiste
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist
||
*name : le nom de l'artist
*image : l'identifiant d'une image (optionnel)
|align='center'|
POST
||
Créé un nouvel objet artiste
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/name/$$ID$$
*$$ID$$ : un id d'artiste
||
*name: le nom de l’artiste
|align='center'|
PUT
||
Modifie le nom de l'artiste
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/image/$$ID$$
*$$ID$$ : un id d'artiste
||
*image: l'identifiant de l'image
|align='center'|
PUT
||
Modifie l'image de l'artiste
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
DELETE
||
Efface l'artiste
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Album=
L'objet album est composé comme suit : {"id":"1","album":"Electro Swing Collection 1","coverId":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/album
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
GET
||
Retourne un objet album
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/artist/$$ID$$
*$$ID$$ : l'identifiant d'un artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/genre/$$ID$$
*$$ID$$ : l'identifiant d'un genre
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'album
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album
||
*name : le nom de l'album
*image : l'identifiant d'une image (optionnel)
|align='center'|
POST
||
Créé un nouvel objet album
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/name/$$ID$$
*$$ID$$ : un id d'album
||
*name: le nom de l’album
|align='center'|
PUT
||
Modifie le nom de l'album
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/image/$$ID$$
*$$ID$$ : un id d'album
||
*image: l'identifiant de l'image
|align='center'|
PUT
||
Modifie l'image de l'album
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
DELETE
||
Efface l'album
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Music=
L'objet musique est composé comme suit : {"id":"1","title":"All Night","artists":["1"],"genres":["1"],"bitrate":"128","hit":"4","duration":"163","id_image":"1"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/music/info/$$ID$$
* $$ID$$ : un identifiant de musique
||
*vide
|align='center'|
GET
||
Retourne un objet musique au format Json
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/content/$$ID$$
* $$ID$$ : un identifiant de musique
||
*vide
|align='center'|
GET
||
Retourne le contenu de la musique (fichier son)<br>
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/album/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objet musiques au format Json appartenant à l'album associé à l'identifiant
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/artist/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objet musiques au format Json dont le créateur est l'artiste associé à l'identifiant
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Image=
L'objet image est composé comme suit : {"id": "1", "content": "/9j/4B4…T0+7RRW/2Q==","mime":"image\jpeg","hash":"0aebaad7…4f265bd"} }
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/images
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets image
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image/info/$$ID$$
*$$ID$$ : un id d'image
||
*vide
|align='center'|
GET
||
Retourne un objet image
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image/content/$$ID$$
*$$ID$$ : un id d'image
||
*vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image
||
*content : le contenu du fichier image
|align='center'|
POST
||
Créé un nouvel objet image
||
*200 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_red_cross.png|center|40px]]
|-
||
/api/image/$$ID$$
*$$ID$$ : un id d'image
||
*content : le contenu du fichier image
|align='center'|
PUT
||
Modifie l'image
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_red_cross.png|center|40px]]
|-
||
/api/image/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
DELETE
||
Efface l'image
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Device=
L'objet périphérique est composé comme suit : {"name":"\/dev\/sda1","label":"MUSIC","size":"7.2 GiB","UUID":"84B9-A853","fstype":"vfat"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/device
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les périphériques
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/list/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* path : un chemin sur le périphérique
* extension : un filtre par extension de fichier (optionnel)
|align='center'|
GET
||
Retourne un tableau avec la liste récursive des fichiers
||
*200 : si l'UUID existe
*400 : si l'UUID n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/explore/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* path : un répertoire sur le périphérique
* extension : un filtre par extension de fichier (optionnel)
|align='center'|
GET
||
Retourne un tableau avec la liste des fichiers et dossiers:

{"directories":["Pop","Rock"],"files":["Gala - Freed From Desire.mp3","13)Jacques Your Body (Make Me Sweat)(Jcf Pitch Edit).mp3"]}
||
*200 : si l'UUID existe
*400 : si l'UUID n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/content/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* path : un chemin sur le périphérique
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/tag/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* path : un chemin sur le périphérique
|align='center'|
GET
||
Retourne un tableau contenant les tags du ou des fichiers présent dans le répertoire
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mounted
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des périphériques montés
||
*200 : si aucune erreur
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/umounted
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des périphériques démontés
||
*200 : si aucune erreur
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mount/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
|align='center'|
POST
||
Monte le périphérique sur le système
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/enable/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
|align='center'|
POST
||
Active le montage du périphérique au démarrage du système
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/index/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* path : un chemin sur le périphérique
|align='center'|
POST
||
Index le répertoire ou le fichier désigné par le paramètre path
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mount/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
|align='center'|
DELETE
||
Démonte le périphérique du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/enable/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
|align='center'|
DELETE
||
Désactive le montage du périphérique au démarrage du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Share=
L'objet partage est composé comme suit : {"host":"hades","share":"downloads","login":"nobody"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/share
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les partages montés
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/list/$$HOST$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste des partages disponibles sur l'hôte
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/list/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un chemin sur le partage
* extension : filtre à appliquer sur les fichiers (optionnel)
|align='center'|
GET
||
Retourne un tableau avec la liste récursive de tous les fichiers disponibles sur le partage

Attention, l'appel peut être long, surtout lorsque les partages contiennent beaucoup de fichiers
||
* 200 : si le partage existe
* 400 : si le partage n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/explore/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un répertoire sur le partage
* extension : un filtre par extension de fichier (optionnel)
|align='center'|
GET
||
Retourne un tableau avec la liste des fichiers
||
*200 : si le partage existe
*400 : si le partage n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/content/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un chemin sur le partage
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/tag/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un chemin sur le partage
|align='center'|
GET
||
Retourne un tableau contenant les tags du ou des fichiers présent dans le répertoire
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* login : le login à utiliser (optionnel)
* password : le mot de passe associé (optionnel)
|align='center'|
POST
||
Monte le partage sur le système. Si aucun couple d'authentification n'est fourni, ''nobody'' sera utilisé
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/index/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un chemin sur le partage
|align='center'|
POST
||
Index le répertoire ou le fichier désigné par le paramètre path
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
|align='center'|
DELETE
||
Démonte le partage du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

= Youtube =
Permet de récupérer des informations sur les vidéo Youtube
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/youtube/info/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère des informations sur la vidéo Youtube. Voici un exemple:

{

"url":"https:\/\/www.youtube.com\/watch?v=eVGrSCrRiy8",

"cover":"https:\/\/i.ytimg.com\/vi\/eVGrSCrRiy8\/maxresdefault.jpg",

"author":"ElectroDanceMixes",

"title":"FESTIVAL MIX - Best EDM & Electro House Dance Party Mix 2018",

"id":"eVGrSCrRiy8",

"videos":["..."]

}
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/youtube/cover/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère la ''pochette'' de la vidéo
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/youtube/listen/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère le contenu de la vidéo
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Player=
Joue la musique sur la carte son du Pi (intégration VLC)
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/player/pause
||
*vide
|align='center'|
GET
||
Met en pause la music
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/stop
||
*vide
|align='center'|
GET
||
Stop la lecture
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/volume/$$PERCENT$$
*$$PERCENT$$ : le volume en poucentage
||
*vide
|align='center'|
GET
||
Règle le volume du lecteur
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/device/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*path : un chemin sur le périphérique
|align='center'|
POST
||
Joue le fichier désigné par ''path'' sur le périphérique ''UUID''
||
*200 : si le fichier et le périphérique existent
*400 : si le fichier ou le périphérique n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
*path : un chemin sur le partage
|align='center'|
POST
||
Joue le fichier désigné par ''path'' sur le partage ''SHARE'' sur l'hôte ''HOST''
||
*200 : si le fichier, le partage et l'hôte existent
*400 : si le fichier, le partage ou l'hôte n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/youtube/$$ID$$
||
* $$ID$$ : un ID de vidéo Youtube (https://www.youtube.com/watch?v=mEYyVY9ffDM → mEYyVY9ffDM)
|align='center'|
POST
||
Joue le son de la vidéo, quand c'est possible (certaines vidéos ne fonctionnent pas)
||
* 200 : si la vidéo existe
* 400 : si le vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/url
||
* path : un lien vers un fichier musical
|align='center'|
POST
||
Joue le fichier
||
* 200 : si la fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Indexer (WIP)=
Permet d'avoir des informations sur les travaux d'indexation en cours. Voici un exemple:
* d'identifiant de travail → 5c2e724887be4;
* d'informations sur un travail → {"files":{"directory":"\/opt\/mount\/192.168.1.252-torrent\/\/Best of POP JCF","total":8,"current":[],"processed":8,"remaining":0,"success":[1,2,3,4,5,6,7,8],"failure":[]},"time":{"start":1546547784,"elapsed":1,"end":1546547785},"state":2}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/index/run
||
*vide
|align='center'|
GET
||
Retourne la liste des identifiants des travaux en cours
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info
||
*vide
|align='center'|
GET
||
Récupère la liste des identifiants des travaux disponibles pour consultation
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
GET
||
Récupère les informations liées au travail désigné par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/run/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
DELETE
||
Stop le travail d'indexation désignè par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
DELETE
||
Supprime les informations liées au travail désigné par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]

Music sender api

2019-01-03T23:28:49Z

Tala : /* Indexer (WIP) */

=User=
L'objet user est composé comme suit : {"id":"1","pseudo":"tala","email":"tala@tala.com","id_image":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/user
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets utilisateur
||
*200 : si l'objet existe
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
*vide
|align='center'|
GET
||
Retourne un objet utilisateur
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/
||
* pseudo : le pseudo de l'utilisateur
* email : le mail de l'utilisateur
* password : le mot de passe de l'utilisateur
* image : l'identifiant de l'image
|align='center'|
POST
||
Crée un nouvel utilisateur et renvoie son identifiant
||
*201 : si la création réussi avec en réponse l'identifiant (eg. {"id":1} )
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/email/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
* email : le mail de l'utilisateur
|align='center'|
PUT
||
Modifie l'email du compte
||
*200 : si la modification réussie
*400 : si une erreur survient
*404 : si l'utilisateur n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/password/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
* password : le nouveau mot de passe utilisateur
|align='center'|
PUT
||
Modifie le mot de passe du compte
||
*200 : si la modification réussie
*400 : si une erreur survient
*404 : si l'utilisateur n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/$$ID$$
*$$ID$$ : un id de d'artiste
||
*vide
|align='center'|
DELETE
||
Efface l'utilisateur
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
*400 : si une erreur survient
||
[[Fichier:implemented_red_cross.png|center|40px]]
|}

=Genre=
L'objet genre est composé comme suit : {"id": "1", "name": "Electro-Jazz"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/genre
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets genre
||
*200 : si l'objet existe
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
GET
||
Retourne un objet genre
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un genre
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets genre
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre
||
*genre : le nom du genre
|align='center'|
POST
||
Créé un nouvel objet genre
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*genre : le nom du genre
|align='center'|
PUT
||
Modifie le nom du genre
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
DELETE
||
Efface le genre
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Artist=
L'objet artiste est composé comme suit : {"id":"84","name":"Yolanda Be Cool & Dcup","id_image":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/artist
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets artiste
||
*200 : si l'objet existe
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
GET
||
Retourne un objet artiste
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets artiste
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist
||
*name : le nom de l'artist
*image : l'identifiant d'une image (optionnel)
|align='center'|
POST
||
Créé un nouvel objet artiste
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/name/$$ID$$
*$$ID$$ : un id d'artiste
||
*name: le nom de l’artiste
|align='center'|
PUT
||
Modifie le nom de l'artiste
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/image/$$ID$$
*$$ID$$ : un id d'artiste
||
*image: l'identifiant de l'image
|align='center'|
PUT
||
Modifie l'image de l'artiste
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
DELETE
||
Efface l'artiste
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Album=
L'objet album est composé comme suit : {"id":"1","album":"Electro Swing Collection 1","coverId":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/album
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
GET
||
Retourne un objet album
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/artist/$$ID$$
*$$ID$$ : l'identifiant d'un artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/genre/$$ID$$
*$$ID$$ : l'identifiant d'un genre
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'album
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album
||
*name : le nom de l'album
*image : l'identifiant d'une image (optionnel)
|align='center'|
POST
||
Créé un nouvel objet album
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/name/$$ID$$
*$$ID$$ : un id d'album
||
*name: le nom de l’album
|align='center'|
PUT
||
Modifie le nom de l'album
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/image/$$ID$$
*$$ID$$ : un id d'album
||
*image: l'identifiant de l'image
|align='center'|
PUT
||
Modifie l'image de l'album
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
DELETE
||
Efface l'album
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Music=
L'objet musique est composé comme suit : {"id":"1","title":"All Night","artists":["1"],"genres":["1"],"bitrate":"128","hit":"4","duration":"163","id_image":"1"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/music/info/$$ID$$
* $$ID$$ : un identifiant de musique
||
*vide
|align='center'|
GET
||
Retourne un objet musique au format Json
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/content/$$ID$$
* $$ID$$ : un identifiant de musique
||
*vide
|align='center'|
GET
||
Retourne le contenu de la musique (fichier son)<br>
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/album/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objet musiques au format Json appartenant à l'album associé à l'identifiant
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/artist/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objet musiques au format Json dont le créateur est l'artiste associé à l'identifiant
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Image=
L'objet image est composé comme suit : {"id": "1", "content": "/9j/4B4…T0+7RRW/2Q==","mime":"image\jpeg","hash":"0aebaad7…4f265bd"} }
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/images
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets image
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image/info/$$ID$$
*$$ID$$ : un id d'image
||
*vide
|align='center'|
GET
||
Retourne un objet image
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image/content/$$ID$$
*$$ID$$ : un id d'image
||
*vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image
||
*content : le contenu du fichier image
|align='center'|
POST
||
Créé un nouvel objet image
||
*200 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_red_cross.png|center|40px]]
|-
||
/api/image/$$ID$$
*$$ID$$ : un id d'image
||
*content : le contenu du fichier image
|align='center'|
PUT
||
Modifie l'image
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_red_cross.png|center|40px]]
|-
||
/api/image/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
DELETE
||
Efface l'image
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Device=
L'objet périphérique est composé comme suit : {"name":"\/dev\/sda1","label":"MUSIC","size":"7.2 GiB","UUID":"84B9-A853","fstype":"vfat"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/device
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les périphériques
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/list/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* path : un chemin sur le périphérique
* extension : un filtre par extension de fichier (optionnel)
|align='center'|
GET
||
Retourne un tableau avec la liste récursive des fichiers
||
*200 : si l'UUID existe
*400 : si l'UUID n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/explore/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* path : un répertoire sur le périphérique
* extension : un filtre par extension de fichier (optionnel)
|align='center'|
GET
||
Retourne un tableau avec la liste des fichiers et dossiers:

{"directories":["Pop","Rock"],"files":["Gala - Freed From Desire.mp3","13)Jacques Your Body (Make Me Sweat)(Jcf Pitch Edit).mp3"]}
||
*200 : si l'UUID existe
*400 : si l'UUID n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/content/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* path : un chemin sur le périphérique
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/tag/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* path : un chemin sur le périphérique
|align='center'|
GET
||
Retourne un tableau contenant les tags du ou des fichiers présent dans le répertoire
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mounted
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des périphériques montés
||
*200 : si aucune erreur
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/umounted
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des périphériques démontés
||
*200 : si aucune erreur
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mount/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
|align='center'|
POST
||
Monte le périphérique sur le système
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/enable/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
|align='center'|
POST
||
Active le montage du périphérique au démarrage du système
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/index/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* path : un chemin sur le périphérique
|align='center'|
POST
||
Index le répertoire ou le fichier désigné par le paramètre path
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mount/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
|align='center'|
DELETE
||
Démonte le périphérique du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/enable/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
|align='center'|
DELETE
||
Désactive le montage du périphérique au démarrage du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Share=
L'objet partage est composé comme suit : {"host":"hades","share":"downloads","login":"nobody"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/share
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les partages montés
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/list/$$HOST$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste des partages disponibles sur l'hôte
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/list/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un chemin sur le partage
* extension : filtre à appliquer sur les fichiers (optionnel)
|align='center'|
GET
||
Retourne un tableau avec la liste récursive de tous les fichiers disponibles sur le partage

Attention, l'appel peut être long, surtout lorsque les partages contiennent beaucoup de fichiers
||
* 200 : si le partage existe
* 400 : si le partage n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/explore/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un répertoire sur le partage
* extension : un filtre par extension de fichier (optionnel)
|align='center'|
GET
||
Retourne un tableau avec la liste des fichiers
||
*200 : si le partage existe
*400 : si le partage n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/content/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un chemin sur le partage
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/tag/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un chemin sur le partage
|align='center'|
GET
||
Retourne un tableau contenant les tags du ou des fichiers présent dans le répertoire
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* login : le login à utiliser (optionnel)
* password : le mot de passe associé (optionnel)
|align='center'|
POST
||
Monte le partage sur le système. Si aucun couple d'authentification n'est fourni, ''nobody'' sera utilisé
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/index/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un chemin sur le partage
|align='center'|
POST
||
Index le répertoire ou le fichier désigné par le paramètre path
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
|align='center'|
DELETE
||
Démonte le partage du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

= Youtube =
Permet de récupérer des informations sur les vidéo Youtube
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/youtube/info/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère des informations sur la vidéo Youtube. Voici un exemple:

{

"url":"https:\/\/www.youtube.com\/watch?v=eVGrSCrRiy8",

"cover":"https:\/\/i.ytimg.com\/vi\/eVGrSCrRiy8\/maxresdefault.jpg",

"author":"ElectroDanceMixes",

"title":"FESTIVAL MIX - Best EDM & Electro House Dance Party Mix 2018",

"id":"eVGrSCrRiy8",

"videos":["..."]

}
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/youtube/cover/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère la ''pochette'' de la vidéo
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/youtube/listen/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère le contenu de la vidéo
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Player=
Joue la musique sur la carte son du Pi (intégration VLC)
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/player/pause
||
*vide
|align='center'|
GET
||
Met en pause la music
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/stop
||
*vide
|align='center'|
GET
||
Stop la lecture
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/volume/$$PERCENT$$
*$$PERCENT$$ : le volume en poucentage
||
*vide
|align='center'|
GET
||
Règle le volume du lecteur
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/device/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*path : un chemin sur le périphérique
|align='center'|
POST
||
Joue le fichier désigné par ''path'' sur le périphérique ''UUID''
||
*200 : si le fichier et le périphérique existent
*400 : si le fichier ou le périphérique n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
*path : un chemin sur le partage
|align='center'|
POST
||
Joue le fichier désigné par ''path'' sur le partage ''SHARE'' sur l'hôte ''HOST''
||
*200 : si le fichier, le partage et l'hôte existent
*400 : si le fichier, le partage ou l'hôte n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/youtube
||
* path : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=mEYyVY9ffDM ou mEYyVY9ffDM)
|align='center'|
POST
||
Joue le son de la vidéo, quand c'est possible (certaines vidéos ne fonctionnent pas)
||
* 200 : si la vidéo existe
* 400 : si le vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/url
||
* path : un lien vers un fichier musical
|align='center'|
POST
||
Joue le fichier
||
* 200 : si la fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Indexer (WIP)=
Permet d'avoir des informations sur les travaux d'indexation en cours. Voici un exemple:
* d'identifiant de travail → 5c2e724887be4;
* d'informations sur un travail → {"files":{"directory":"\/opt\/mount\/192.168.1.252-torrent\/\/Best of POP JCF","total":8,"current":[],"processed":8,"remaining":0,"success":[1,2,3,4,5,6,7,8],"failure":[]},"time":{"start":1546547784,"elapsed":1,"end":1546547785},"state":2}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/index/run
||
*vide
|align='center'|
GET
||
Retourne la liste des identifiants des travaux en cours
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info
||
*vide
|align='center'|
GET
||
Récupère la liste des identifiants des travaux disponibles pour consultation
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
GET
||
Récupère les informations liées au travail désigné par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/run/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
DELETE
||
Stop le travail d'indexation désignè par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
DELETE
||
Supprime les informations liées au travail désigné par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]

Roadmap orange pi music

2019-01-03T22:59:43Z

Tala : /* GUI */

== Fonctionnalités ==
* Réfléchir à un système de playlist, avec ou sans indexation;
== API ==
* Finir la partie relative à Youtube ;
* Procéder à une authentification (OAuth);
== GUI ==
===Partie device===
* Listage des périphériques USB montés / démontés
[[Fichier:device_available.png|centré|500px]]
* Montage d'un périphérique USB
[[Fichier:device_mount.png|centré|500px]]
* Parcours d'un périphérique USB monté
{|
|-
||
[[Fichier:device_explorer.png|centré|500px]]
||
[[Fichier:device_explorer1.png|centré|500px]]
|}
===Partie share===
* Parcours des partages SMB/CIFS sur un hôte
[[Fichier:share_host.png|centré|500px]]
* Montage d'un partage avec automount
[[Fichier:share_mount.png|centré|500px]]
*Parcours d'un partage
{|
|-
||
[[Fichier:share_explorer1.png|centré|500px]]
||
[[Fichier:share_explorer.png|centré|500px]]
|}
===Partie player===
*Lecture d'un MP3 avec tag
{|
|-
||
[[Fichier:player_1.png|centré|500px]]
||
[[Fichier:player_2.png|centré|500px]]
|}

== Kernel ==
* Écrire un démon ou faire un CRON ;
* Utiliser un fichier de configuration global ;
* Tester la présence de périphérique USB ;

== BUGS ==
=== BDD ===
* La partie indexation mérite réflexion, dans cet état elle est trop restrictive et nécessite un TAG trop parfait pour réussir. Voir pour faire une indexation plus souple qui réussie même en l'absence de certain champ (artiste, album, genre, pochette, etc...). Problème à régler dans la classe ''DaoMusique'' et ''Tag''.
* Problème de typage pour le champ ''duration'', il faut le repasser en secondes pour que cela fonctionne
<pre>
select * from music;
+----------+------------------------+---------+------+----------+----------------------------------------------+----------+
| id_music | title | bitrate | hit | duration | path | id_image |
+----------+------------------------+---------+------+----------+----------------------------------------------+----------+
| 1 | Five More hours | 128 | 0 | 3 | Deorro & Chris Brown Five More Hours.mp3 | 1 |
| 2 | Milkshake (TRFN Remix) | 192 | 0 | 2 | 2018/Kelis - Milkshake (TRFN Remix).mp3 | 2 |
| 3 | Uptown Funk | 128 | 0 | 4 | Mark Ronson ft. Bruno Mars - Uptown Funk.mp3 | 3 |
| 4 | Want To Want Me | 128 | 0 | 3 | Jason Derulo - Want To Want Me.mp3 | 4 |
| 5 | Love Me Like You Do | 128 | 0 | 4 | Ellie Goulding - Love Me Like You Do.mp3 | 1 |
| 6 | Take Me To Church | 128 | 0 | 4 | Hozier - Take Me To Church.mp3 | 1 |
+----------+------------------------+---------+------+----------+----------------------------------------------+----------+
</pre>

Fichier:Device mount.png

2019-01-03T22:59:04Z

Tala :

Fichier:Device available.png

2019-01-03T22:58:43Z

Tala : Tala a téléversé une nouvelle version de Fichier:Device available.png

Fichier:Device available.png

2019-01-03T22:57:59Z

Tala :

Fichier:Device explorer.png

2019-01-03T22:56:50Z

Tala :

Fichier:Device explorer1.png

2019-01-03T22:56:29Z

Tala :

Fichier:Share host.png

2019-01-03T22:54:32Z

Tala :

Fichier:Share mount.png

2019-01-03T22:54:17Z

Tala :

Fichier:Share explorer1.png

2019-01-03T22:53:40Z

Tala :

Fichier:Share explorer.png

2019-01-03T22:52:23Z

Tala :

Fichier:Player 2.png

2019-01-03T22:51:06Z

Tala :

Fichier:Player 1.png

2019-01-03T22:50:35Z

Tala :

Roadmap orange pi music

2019-01-03T22:37:50Z

Tala :

== Fonctionnalités ==
* Réfléchir à un système de playlist, avec ou sans indexation;
== API ==
* Finir la partie relative à Youtube ;
* Procéder à une authentification (OAuth);
== GUI ==
TODO

== Kernel ==
* Écrire un démon ou faire un CRON ;
* Utiliser un fichier de configuration global ;
* Tester la présence de périphérique USB ;

== BUGS ==
=== BDD ===
* La partie indexation mérite réflexion, dans cet état elle est trop restrictive et nécessite un TAG trop parfait pour réussir. Voir pour faire une indexation plus souple qui réussie même en l'absence de certain champ (artiste, album, genre, pochette, etc...). Problème à régler dans la classe ''DaoMusique'' et ''Tag''.
* Problème de typage pour le champ ''duration'', il faut le repasser en secondes pour que cela fonctionne
<pre>
select * from music;
+----------+------------------------+---------+------+----------+----------------------------------------------+----------+
| id_music | title | bitrate | hit | duration | path | id_image |
+----------+------------------------+---------+------+----------+----------------------------------------------+----------+
| 1 | Five More hours | 128 | 0 | 3 | Deorro & Chris Brown Five More Hours.mp3 | 1 |
| 2 | Milkshake (TRFN Remix) | 192 | 0 | 2 | 2018/Kelis - Milkshake (TRFN Remix).mp3 | 2 |
| 3 | Uptown Funk | 128 | 0 | 4 | Mark Ronson ft. Bruno Mars - Uptown Funk.mp3 | 3 |
| 4 | Want To Want Me | 128 | 0 | 3 | Jason Derulo - Want To Want Me.mp3 | 4 |
| 5 | Love Me Like You Do | 128 | 0 | 4 | Ellie Goulding - Love Me Like You Do.mp3 | 1 |
| 6 | Take Me To Church | 128 | 0 | 4 | Hozier - Take Me To Church.mp3 | 1 |
+----------+------------------------+---------+------+----------+----------------------------------------------+----------+
</pre>

Roadmap orange pi music

2019-01-03T22:03:20Z

Tala : /* Kernel */

== API ==
* Finir la partie relative à Youtube ;

== GUI ==
TODO

== Kernel ==
* Écrire un démon ou faire un CRON ;
* Utiliser un fichier de configuration global ;
* Tester la présence de périphérique USB ;

== BUGS ==
=== BDD ===
* La partie indexation mérite réflexion, dans cet état elle est trop restrictive et nécessite un TAG trop parfait pour réussir. Voir pour faire une indexation plus souple qui réussie même en l'absence de certain champ (artiste, album, genre, pochette, etc...). Problème à régler dans la classe ''DaoMusique'' et ''Tag''.
* Problème de typage pour le champ ''duration'', il faut le repasser en secondes pour que cela fonctionne
<pre>
select * from music;
+----------+------------------------+---------+------+----------+----------------------------------------------+----------+
| id_music | title | bitrate | hit | duration | path | id_image |
+----------+------------------------+---------+------+----------+----------------------------------------------+----------+
| 1 | Five More hours | 128 | 0 | 3 | Deorro & Chris Brown Five More Hours.mp3 | 1 |
| 2 | Milkshake (TRFN Remix) | 192 | 0 | 2 | 2018/Kelis - Milkshake (TRFN Remix).mp3 | 2 |
| 3 | Uptown Funk | 128 | 0 | 4 | Mark Ronson ft. Bruno Mars - Uptown Funk.mp3 | 3 |
| 4 | Want To Want Me | 128 | 0 | 3 | Jason Derulo - Want To Want Me.mp3 | 4 |
| 5 | Love Me Like You Do | 128 | 0 | 4 | Ellie Goulding - Love Me Like You Do.mp3 | 1 |
| 6 | Take Me To Church | 128 | 0 | 4 | Hozier - Take Me To Church.mp3 | 1 |
+----------+------------------------+---------+------+----------+----------------------------------------------+----------+
</pre>

Music sender api

2019-01-03T20:39:19Z

Tala : /* Indexer (WIP) */

=User=
L'objet user est composé comme suit : {"id":"1","pseudo":"tala","email":"tala@tala.com","id_image":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/user
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets utilisateur
||
*200 : si l'objet existe
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
*vide
|align='center'|
GET
||
Retourne un objet utilisateur
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/
||
* pseudo : le pseudo de l'utilisateur
* email : le mail de l'utilisateur
* password : le mot de passe de l'utilisateur
* image : l'identifiant de l'image
|align='center'|
POST
||
Crée un nouvel utilisateur et renvoie son identifiant
||
*201 : si la création réussi avec en réponse l'identifiant (eg. {"id":1} )
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/email/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
* email : le mail de l'utilisateur
|align='center'|
PUT
||
Modifie l'email du compte
||
*200 : si la modification réussie
*400 : si une erreur survient
*404 : si l'utilisateur n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/password/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
* password : le nouveau mot de passe utilisateur
|align='center'|
PUT
||
Modifie le mot de passe du compte
||
*200 : si la modification réussie
*400 : si une erreur survient
*404 : si l'utilisateur n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/$$ID$$
*$$ID$$ : un id de d'artiste
||
*vide
|align='center'|
DELETE
||
Efface l'utilisateur
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
*400 : si une erreur survient
||
[[Fichier:implemented_red_cross.png|center|40px]]
|}

=Genre=
L'objet genre est composé comme suit : {"id": "1", "name": "Electro-Jazz"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/genre
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets genre
||
*200 : si l'objet existe
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
GET
||
Retourne un objet genre
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un genre
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets genre
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre
||
*genre : le nom du genre
|align='center'|
POST
||
Créé un nouvel objet genre
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*genre : le nom du genre
|align='center'|
PUT
||
Modifie le nom du genre
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
DELETE
||
Efface le genre
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Artist=
L'objet artiste est composé comme suit : {"id":"84","name":"Yolanda Be Cool & Dcup","id_image":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/artist
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets artiste
||
*200 : si l'objet existe
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
GET
||
Retourne un objet artiste
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets artiste
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist
||
*name : le nom de l'artist
*image : l'identifiant d'une image (optionnel)
|align='center'|
POST
||
Créé un nouvel objet artiste
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/name/$$ID$$
*$$ID$$ : un id d'artiste
||
*name: le nom de l’artiste
|align='center'|
PUT
||
Modifie le nom de l'artiste
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/image/$$ID$$
*$$ID$$ : un id d'artiste
||
*image: l'identifiant de l'image
|align='center'|
PUT
||
Modifie l'image de l'artiste
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
DELETE
||
Efface l'artiste
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Album=
L'objet album est composé comme suit : {"id":"1","album":"Electro Swing Collection 1","coverId":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/album
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
GET
||
Retourne un objet album
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/artist/$$ID$$
*$$ID$$ : l'identifiant d'un artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/genre/$$ID$$
*$$ID$$ : l'identifiant d'un genre
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'album
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album
||
*name : le nom de l'album
*image : l'identifiant d'une image (optionnel)
|align='center'|
POST
||
Créé un nouvel objet album
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/name/$$ID$$
*$$ID$$ : un id d'album
||
*name: le nom de l’album
|align='center'|
PUT
||
Modifie le nom de l'album
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/image/$$ID$$
*$$ID$$ : un id d'album
||
*image: l'identifiant de l'image
|align='center'|
PUT
||
Modifie l'image de l'album
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
DELETE
||
Efface l'album
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Music=
L'objet musique est composé comme suit : {"id":"1","title":"All Night","artists":["1"],"genres":["1"],"bitrate":"128","hit":"4","duration":"163","id_image":"1"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/music/info/$$ID$$
* $$ID$$ : un identifiant de musique
||
*vide
|align='center'|
GET
||
Retourne un objet musique au format Json
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/content/$$ID$$
* $$ID$$ : un identifiant de musique
||
*vide
|align='center'|
GET
||
Retourne le contenu de la musique (fichier son)<br>
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/album/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objet musiques au format Json appartenant à l'album associé à l'identifiant
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/artist/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objet musiques au format Json dont le créateur est l'artiste associé à l'identifiant
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Image=
L'objet image est composé comme suit : {"id": "1", "content": "/9j/4B4…T0+7RRW/2Q==","mime":"image\jpeg","hash":"0aebaad7…4f265bd"} }
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/images
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets image
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image/info/$$ID$$
*$$ID$$ : un id d'image
||
*vide
|align='center'|
GET
||
Retourne un objet image
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image/content/$$ID$$
*$$ID$$ : un id d'image
||
*vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image
||
*content : le contenu du fichier image
|align='center'|
POST
||
Créé un nouvel objet image
||
*200 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_red_cross.png|center|40px]]
|-
||
/api/image/$$ID$$
*$$ID$$ : un id d'image
||
*content : le contenu du fichier image
|align='center'|
PUT
||
Modifie l'image
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_red_cross.png|center|40px]]
|-
||
/api/image/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
DELETE
||
Efface l'image
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Device=
L'objet périphérique est composé comme suit : {"name":"\/dev\/sda1","label":"MUSIC","size":"7.2 GiB","UUID":"84B9-A853","fstype":"vfat"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/device
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les périphériques
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/list/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* path : un chemin sur le périphérique
* extension : un filtre par extension de fichier (optionnel)
|align='center'|
GET
||
Retourne un tableau avec la liste récursive des fichiers
||
*200 : si l'UUID existe
*400 : si l'UUID n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/explore/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* path : un répertoire sur le périphérique
* extension : un filtre par extension de fichier (optionnel)
|align='center'|
GET
||
Retourne un tableau avec la liste des fichiers et dossiers:

{"directories":["Pop","Rock"],"files":["Gala - Freed From Desire.mp3","13)Jacques Your Body (Make Me Sweat)(Jcf Pitch Edit).mp3"]}
||
*200 : si l'UUID existe
*400 : si l'UUID n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/content/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* path : un chemin sur le périphérique
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/tag/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* path : un chemin sur le périphérique
|align='center'|
GET
||
Retourne un tableau contenant les tags du ou des fichiers présent dans le répertoire
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mounted
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des périphériques montés
||
*200 : si aucune erreur
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/umounted
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des périphériques démontés
||
*200 : si aucune erreur
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mount/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
|align='center'|
POST
||
Monte le périphérique sur le système
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/enable/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
|align='center'|
POST
||
Active le montage du périphérique au démarrage du système
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/index/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* path : un chemin sur le périphérique
|align='center'|
POST
||
Index le répertoire ou le fichier désigné par le paramètre path
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mount/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
|align='center'|
DELETE
||
Démonte le périphérique du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/enable/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
|align='center'|
DELETE
||
Désactive le montage du périphérique au démarrage du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Share=
L'objet partage est composé comme suit : {"host":"hades","share":"downloads","login":"nobody"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/share
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les partages montés
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/list/$$HOST$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste des partages disponibles sur l'hôte
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/list/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un chemin sur le partage
* extension : filtre à appliquer sur les fichiers (optionnel)
|align='center'|
GET
||
Retourne un tableau avec la liste récursive de tous les fichiers disponibles sur le partage

Attention, l'appel peut être long, surtout lorsque les partages contiennent beaucoup de fichiers
||
* 200 : si le partage existe
* 400 : si le partage n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/explore/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un répertoire sur le partage
* extension : un filtre par extension de fichier (optionnel)
|align='center'|
GET
||
Retourne un tableau avec la liste des fichiers
||
*200 : si le partage existe
*400 : si le partage n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/content/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un chemin sur le partage
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/tag/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un chemin sur le partage
|align='center'|
GET
||
Retourne un tableau contenant les tags du ou des fichiers présent dans le répertoire
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* login : le login à utiliser (optionnel)
* password : le mot de passe associé (optionnel)
|align='center'|
POST
||
Monte le partage sur le système. Si aucun couple d'authentification n'est fourni, ''nobody'' sera utilisé
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/index/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un chemin sur le partage
|align='center'|
POST
||
Index le répertoire ou le fichier désigné par le paramètre path
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
|align='center'|
DELETE
||
Démonte le partage du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

= Youtube =
Permet de récupérer des informations sur les vidéo Youtube
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/youtube/info/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère des informations sur la vidéo Youtube. Voici un exemple:

{

"url":"https:\/\/www.youtube.com\/watch?v=eVGrSCrRiy8",

"cover":"https:\/\/i.ytimg.com\/vi\/eVGrSCrRiy8\/maxresdefault.jpg",

"author":"ElectroDanceMixes",

"title":"FESTIVAL MIX - Best EDM & Electro House Dance Party Mix 2018",

"id":"eVGrSCrRiy8",

"videos":["..."]

}
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/youtube/cover/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère la ''pochette'' de la vidéo
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/youtube/listen/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère le contenu de la vidéo
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Player=
Joue la musique sur la carte son du Pi (intégration VLC)
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/player/pause
||
*vide
|align='center'|
GET
||
Met en pause la music
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/stop
||
*vide
|align='center'|
GET
||
Stop la lecture
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/volume/$$PERCENT$$
*$$PERCENT$$ : le volume en poucentage
||
*vide
|align='center'|
GET
||
Règle le volume du lecteur
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/device/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*path : un chemin sur le périphérique
|align='center'|
POST
||
Joue le fichier désigné par ''path'' sur le périphérique ''UUID''
||
*200 : si le fichier et le périphérique existent
*400 : si le fichier ou le périphérique n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
*path : un chemin sur le partage
|align='center'|
POST
||
Joue le fichier désigné par ''path'' sur le partage ''SHARE'' sur l'hôte ''HOST''
||
*200 : si le fichier, le partage et l'hôte existent
*400 : si le fichier, le partage ou l'hôte n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/youtube
||
* path : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=mEYyVY9ffDM ou mEYyVY9ffDM)
|align='center'|
POST
||
Joue le son de la vidéo, quand c'est possible (certaines vidéos ne fonctionnent pas)
||
* 200 : si la vidéo existe
* 400 : si le vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/url
||
* path : un lien vers un fichier musical
|align='center'|
POST
||
Joue le fichier
||
* 200 : si la fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Indexer (WIP)=
Permet d'avoir des informations sur les travaux d'indexation en cours. Voici un exemple:
* d'identifiant de travai → 5c2e724887be4;
* d'informations sur un travail → {"files":{"directory":"\/opt\/mount\/192.168.1.252-torrent\/\/Best of POP JCF","total":8,"current":[],"processed":8,"remaining":0,"success":[1,2,3,4,5,6,7,8],"failure":[]},"time":{"start":1546547784,"elapsed":1,"end":1546547785},"state":2}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/index/run
||
*vide
|align='center'|
GET
||
Retourne la liste des identifiants des travaux en cours
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info
||
*vide
|align='center'|
GET
||
Récupère la liste des identifiants des travaux disponibles pour consultation
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
GET
||
Récupère les informations liées au travail désigné par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/run/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
DELETE
||
Stop le travail d'indexation désignè par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
DELETE
||
Supprime les informations liées au travail désigné par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]

Music sender api

2019-01-03T20:35:47Z

Tala : /* Indexer (WIP) */

=User=
L'objet user est composé comme suit : {"id":"1","pseudo":"tala","email":"tala@tala.com","id_image":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/user
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets utilisateur
||
*200 : si l'objet existe
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
*vide
|align='center'|
GET
||
Retourne un objet utilisateur
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/
||
* pseudo : le pseudo de l'utilisateur
* email : le mail de l'utilisateur
* password : le mot de passe de l'utilisateur
* image : l'identifiant de l'image
|align='center'|
POST
||
Crée un nouvel utilisateur et renvoie son identifiant
||
*201 : si la création réussi avec en réponse l'identifiant (eg. {"id":1} )
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/email/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
* email : le mail de l'utilisateur
|align='center'|
PUT
||
Modifie l'email du compte
||
*200 : si la modification réussie
*400 : si une erreur survient
*404 : si l'utilisateur n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/password/$$ID$$
* $$ID$$ : un identifiant utilisateur
||
* password : le nouveau mot de passe utilisateur
|align='center'|
PUT
||
Modifie le mot de passe du compte
||
*200 : si la modification réussie
*400 : si une erreur survient
*404 : si l'utilisateur n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/user/$$ID$$
*$$ID$$ : un id de d'artiste
||
*vide
|align='center'|
DELETE
||
Efface l'utilisateur
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
*400 : si une erreur survient
||
[[Fichier:implemented_red_cross.png|center|40px]]
|}

=Genre=
L'objet genre est composé comme suit : {"id": "1", "name": "Electro-Jazz"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/genre
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets genre
||
*200 : si l'objet existe
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
GET
||
Retourne un objet genre
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un genre
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets genre
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre
||
*genre : le nom du genre
|align='center'|
POST
||
Créé un nouvel objet genre
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*genre : le nom du genre
|align='center'|
PUT
||
Modifie le nom du genre
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
DELETE
||
Efface le genre
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Artist=
L'objet artiste est composé comme suit : {"id":"84","name":"Yolanda Be Cool & Dcup","id_image":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/artist
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets artiste
||
*200 : si l'objet existe
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
GET
||
Retourne un objet artiste
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets artiste
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist
||
*name : le nom de l'artist
*image : l'identifiant d'une image (optionnel)
|align='center'|
POST
||
Créé un nouvel objet artiste
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/name/$$ID$$
*$$ID$$ : un id d'artiste
||
*name: le nom de l’artiste
|align='center'|
PUT
||
Modifie le nom de l'artiste
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/artist/image/$$ID$$
*$$ID$$ : un id d'artiste
||
*image: l'identifiant de l'image
|align='center'|
PUT
||
Modifie l'image de l'artiste
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
DELETE
||
Efface l'artiste
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Album=
L'objet album est composé comme suit : {"id":"1","album":"Electro Swing Collection 1","coverId":null}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/album
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
GET
||
Retourne un objet album
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/artist/$$ID$$
*$$ID$$ : l'identifiant d'un artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/genre/$$ID$$
*$$ID$$ : l'identifiant d'un genre
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/like/$$EXPR$$
*$$EXPR$$ : une expression contenu dans un nom d'album
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objets album
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album
||
*name : le nom de l'album
*image : l'identifiant d'une image (optionnel)
|align='center'|
POST
||
Créé un nouvel objet album
||
*201 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/name/$$ID$$
*$$ID$$ : un id d'album
||
*name: le nom de l’album
|align='center'|
PUT
||
Modifie le nom de l'album
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/album/image/$$ID$$
*$$ID$$ : un id d'album
||
*image: l'identifiant de l'image
|align='center'|
PUT
||
Modifie l'image de l'album
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/genre/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
DELETE
||
Efface l'album
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Music=
L'objet musique est composé comme suit : {"id":"1","title":"All Night","artists":["1"],"genres":["1"],"bitrate":"128","hit":"4","duration":"163","id_image":"1"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/music/info/$$ID$$
* $$ID$$ : un identifiant de musique
||
*vide
|align='center'|
GET
||
Retourne un objet musique au format Json
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/content/$$ID$$
* $$ID$$ : un identifiant de musique
||
*vide
|align='center'|
GET
||
Retourne le contenu de la musique (fichier son)<br>
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/album/$$ID$$
*$$ID$$ : un id d'album
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objet musiques au format Json appartenant à l'album associé à l'identifiant
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/music/artist/$$ID$$
*$$ID$$ : un id d'artiste
||
*vide
|align='center'|
GET
||
Retourne un tableau d'objet musiques au format Json dont le créateur est l'artiste associé à l'identifiant
||
*200 : si l'objet existe;
*400 : si une erreur survient;
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Image=
L'objet image est composé comme suit : {"id": "1", "content": "/9j/4B4…T0+7RRW/2Q==","mime":"image\jpeg","hash":"0aebaad7…4f265bd"} }
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/images
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les objets image
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image/info/$$ID$$
*$$ID$$ : un id d'image
||
*vide
|align='center'|
GET
||
Retourne un objet image
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image/content/$$ID$$
*$$ID$$ : un id d'image
||
*vide
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
*200 : si l'objet existe
*404 : si l'objet n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/image
||
*content : le contenu du fichier image
|align='center'|
POST
||
Créé un nouvel objet image
||
*200 : si la création réussie
*400 : si la création échoue
||
[[Fichier:implemented_red_cross.png|center|40px]]
|-
||
/api/image/$$ID$$
*$$ID$$ : un id d'image
||
*content : le contenu du fichier image
|align='center'|
PUT
||
Modifie l'image
||
*200 : si la modification réussie
*400 : si la modification échoue
||
[[Fichier:implemented_red_cross.png|center|40px]]
|-
||
/api/image/$$ID$$
*$$ID$$ : un id de genre
||
*vide
|align='center'|
DELETE
||
Efface l'image
||
*200 : si l'effacement réussie
*400 : si l'effacement échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Device=
L'objet périphérique est composé comme suit : {"name":"\/dev\/sda1","label":"MUSIC","size":"7.2 GiB","UUID":"84B9-A853","fstype":"vfat"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/device
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les périphériques
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/list/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* path : un chemin sur le périphérique
* extension : un filtre par extension de fichier (optionnel)
|align='center'|
GET
||
Retourne un tableau avec la liste récursive des fichiers
||
*200 : si l'UUID existe
*400 : si l'UUID n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/explore/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* path : un répertoire sur le périphérique
* extension : un filtre par extension de fichier (optionnel)
|align='center'|
GET
||
Retourne un tableau avec la liste des fichiers et dossiers:

{"directories":["Pop","Rock"],"files":["Gala - Freed From Desire.mp3","13)Jacques Your Body (Make Me Sweat)(Jcf Pitch Edit).mp3"]}
||
*200 : si l'UUID existe
*400 : si l'UUID n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/content/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* path : un chemin sur le périphérique
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/tag/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* path : un chemin sur le périphérique
|align='center'|
GET
||
Retourne un tableau contenant les tags du ou des fichiers présent dans le répertoire
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mounted
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des périphériques montés
||
*200 : si aucune erreur
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/umounted
||
*vide
|align='center'|
GET
||
Retourne un tableau avec la liste des périphériques démontés
||
*200 : si aucune erreur
*400 : si une erreur survient
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mount/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
|align='center'|
POST
||
Monte le périphérique sur le système
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/enable/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
|align='center'|
POST
||
Active le montage du périphérique au démarrage du système
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/index/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
* path : un chemin sur le périphérique
|align='center'|
POST
||
Index le répertoire ou le fichier désigné par le paramètre path
||
*200 : si le fichier existe
*400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/mount/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
|align='center'|
DELETE
||
Démonte le périphérique du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/enable/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
|align='center'|
DELETE
||
Désactive le montage du périphérique au démarrage du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Share=
L'objet partage est composé comme suit : {"host":"hades","share":"downloads","login":"nobody"}
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/share
||
*vide
|align='center'|
GET
||
Retourne un tableau avec tous les partages montés
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/list/$$HOST$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
||
* vide
|align='center'|
GET
||
Retourne un tableau avec la liste des partages disponibles sur l'hôte
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/list/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un chemin sur le partage
* extension : filtre à appliquer sur les fichiers (optionnel)
|align='center'|
GET
||
Retourne un tableau avec la liste récursive de tous les fichiers disponibles sur le partage

Attention, l'appel peut être long, surtout lorsque les partages contiennent beaucoup de fichiers
||
* 200 : si le partage existe
* 400 : si le partage n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/device/explore/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un répertoire sur le partage
* extension : un filtre par extension de fichier (optionnel)
|align='center'|
GET
||
Retourne un tableau avec la liste des fichiers
||
*200 : si le partage existe
*400 : si le partage n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/content/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un chemin sur le partage
|align='center'|
GET
||
Retourne le contenu du fichier avec le type mime en entête
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/tag/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un chemin sur le partage
|align='center'|
GET
||
Retourne un tableau contenant les tags du ou des fichiers présent dans le répertoire
||
* 200 : si le fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* login : le login à utiliser (optionnel)
* password : le mot de passe associé (optionnel)
|align='center'|
POST
||
Monte le partage sur le système. Si aucun couple d'authentification n'est fourni, ''nobody'' sera utilisé
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/index/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
* path : un chemin sur le partage
|align='center'|
POST
||
Index le répertoire ou le fichier désigné par le paramètre path
||
*200 : si le montage réussie
*400 : si le montage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
|align='center'|
DELETE
||
Démonte le partage du système
||
*200 : si le démontage réussie
*400 : si le démontage échoue
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

= Youtube =
Permet de récupérer des informations sur les vidéo Youtube
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/youtube/info/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère des informations sur la vidéo Youtube. Voici un exemple:

{

"url":"https:\/\/www.youtube.com\/watch?v=eVGrSCrRiy8",

"cover":"https:\/\/i.ytimg.com\/vi\/eVGrSCrRiy8\/maxresdefault.jpg",

"author":"ElectroDanceMixes",

"title":"FESTIVAL MIX - Best EDM & Electro House Dance Party Mix 2018",

"id":"eVGrSCrRiy8",

"videos":["..."]

}
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/youtube/cover/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère la ''pochette'' de la vidéo
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/youtube/listen/$$ID$$
* $$ID$$ : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=eVGrSCrRiy8 ou eVGrSCrRiy8)
||
*vide
|align='center'|
GET
||
Récupère le contenu de la vidéo
||
*200 : si la vidéo existe
*200 : si la vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}
=Player=
Joue la musique sur la carte son du Pi (intégration VLC)
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/player/pause
||
*vide
|align='center'|
GET
||
Met en pause la music
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/stop
||
*vide
|align='center'|
GET
||
Stop la lecture
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/volume/$$PERCENT$$
*$$PERCENT$$ : le volume en poucentage
||
*vide
|align='center'|
GET
||
Règle le volume du lecteur
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/device/$$UUID$$
*$$UUID$$ : un UUID de périphérique
||
*path : un chemin sur le périphérique
|align='center'|
POST
||
Joue le fichier désigné par ''path'' sur le périphérique ''UUID''
||
*200 : si le fichier et le périphérique existent
*400 : si le fichier ou le périphérique n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/share/$$HOST$$/$$SHARE$$
*$$HOST$$ : un hôte supportant le protocole SMB/CIFS
*$$SHARE$$ : le nom du partage sur cet hôte
||
*path : un chemin sur le partage
|align='center'|
POST
||
Joue le fichier désigné par ''path'' sur le partage ''SHARE'' sur l'hôte ''HOST''
||
*200 : si le fichier, le partage et l'hôte existent
*400 : si le fichier, le partage ou l'hôte n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/youtube
||
* path : un lien ou ID de vidéo Youtube (https://www.youtube.com/watch?v=mEYyVY9ffDM ou mEYyVY9ffDM)
|align='center'|
POST
||
Joue le son de la vidéo, quand c'est possible (certaines vidéos ne fonctionnent pas)
||
* 200 : si la vidéo existe
* 400 : si le vidéo n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/player/url
||
* path : un lien vers un fichier musical
|align='center'|
POST
||
Joue le fichier
||
* 200 : si la fichier existe
* 400 : si le fichier n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|}

=Indexer (WIP)=
Permet d'avoir des informations sur les travaux d'indexation en cours
{|class="wikitable" width="100%"
|-valign=top
! URL !! Corps !! Verbe !! Action !! Code retour !! Implémentée
|-
||
/api/index/run
||
*vide
|align='center'|
GET
||
Retourne la liste des identifiants des travaux en cours
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info
||
*vide
|align='center'|
GET
||
Récupère la liste des identifiants des travaux disponibles pour consultation
||
*200
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
GET
||
Récupère les informations liées au travail désigné par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/run/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
DELETE
||
Stop le travail d'indexation désignè par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]
|-
||
/api/index/info/$$ID$$
*$$ID$$ : l'identifiant du travail
||
*vide
|align='center'|
DELETE
||
Supprime les informations liées au travail désigné par $$ID$$
||
*200 : si l'identifiant existe
*400 : si l'identifiant n'existe pas
||
[[Fichier:implemented_green_tick.png|center|40px]]