PHPackages                             ayrel/karotz - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. ayrel/karotz

ActiveLibrary[API Development](/categories/api)

ayrel/karotz
============

api karotz

05PHP

Since Jun 15Pushed 7y ago1 watchersCompare

[ Source](https://github.com/Ayrel/Karotz)[ Packagist](https://packagist.org/packages/ayrel/karotz)[ RSS](/packages/ayrel-karotz/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

OpenKarotz PHP Class Documentation
==================================

[](#openkarotz-php-class-documentation)

Bonjour tout le monde, je suis [GilDev](http://twitter.com/GilDev), et voici la documentation de ma classe PHP qui vous permet de contrôler votre OpenKarotz facilement. Elle utilise l'API HTTP officielle d'OpenKarotz. Vous aurez besoin de PHP 5.4+ ainsi que la bibliothèque [cURL](http://php.net/curl) pour utiliser cette classe.

J'ai essayé de documenter du mieux que j'ai pu, notamment en essayant de me rapprocher au maximum de la syntaxe des synopsis des fonctions de la documentation PHP officielle.
Par exemple, voici le synopsis de la fonction `pulse()` :

```
$out = $karotz->pulse($primaryColor [, $secondaryColor = '000000' [, $speed = 700]]);

```

Cet exemple appelle la fonction `pulse()` sur l'objet `$karotz`. Le paramètre `$primaryColor` est indispensable, cependant, les paramètres `$secondaryColor` et `$speed` sont optionnels (entre crochets) et ont par défaut les valeurs respectives `'000000'` et `700` s'ils ne sont pas renseignés.

Si aucun exemple de retour n'est présent pour une fonction, c'est que la fonction retourne uniquement :

```
Array
(
	[return] => 0
)

```

S'il y a une erreur dans un appel de fonction, l'index `return` vaudra `1` et l'index `msg` contiendra le message d'erreur.

Pour toute question, me contacter sur [Twitter](http://twitter.com/GilDev) ou par [mail](mailto:gildev@gmail.com).

[![WTFPL](https://camo.githubusercontent.com/4051644883ab2869f11be71537ea53f57bbb44f1dfa2da471ab524f02f87b331/687474703a2f2f7777772e777466706c2e6e65742f77702d636f6e74656e742f75706c6f6164732f323031322f31322f777466706c2d62616467652d342e706e67)](http://www.wtfpl.net/txt/copying/)

---

Sommaire des fonctions
----------------------

[](#sommaire-des-fonctions)

- [Informations](#informations)
    - [getStatus()](#getstatus)
    - [getStorage()](#getstorage)
    - [getList()](#getlist)
- [État](#etat)
    - [wakeUp()](#wakeup)
    - [sleep()](#sleep)
- [Leds](#leds)
    - [led()](#led)
    - [pulse()](#pulse)
- [Oreilles](#oreilles)
    - [earsMode()](#earsmode)
    - [ears()](#ears)
    - [earsReset()](#earsreset)
    - [earsRandom()](#earsrandom)
- [RFID](#rfid)
    - [rfidStartRecord()](#rfidstartrecord)
    - [rfidStopRecord()](#rfidstoprecord)
    - [rfidDelete()](#rfiddelete)
    - [rfidUnassign()](#rfidunassign)
    - [rfidAssignURL()](#rfidassignurl)
- [TTS](#tts)
    - [getCache()](#getcache)
    - [clearCache()](#clearcache)
    - [say()](#say)
- [Photos](#photos)
    - [clearSnapshots()](#clearsnapshots)
    - [takeSnapshot()](#takesnapshot)
- [Sons](#sons)
    - [play()](#play)
    - [playStream()](#playstream)
    - [pause()](#pause)
    - [stop()](#stop)
    - [squeezeboxStart()](#squeezeboxstart)
    - [squeezeboxStop()](#squeezeboxstop)
- [Applications](#applications)
    - [playMood()](#playmood)
    - [playClock()](#playclock)

---

Créer un nouveau object OpenKarotz
----------------------------------

[](#créer-un-nouveau-object-openkarotz)

Pour commencer, crééz un nouvel objet OpenKarotz comme ceci :

```
require 'OpenKarotz.class.php';

try {
	$karotz = new OpenKarotz('x.x.x.x');
} catch (Exception $e) {
	echo 'Erreur : ' . $e->getMessage();
	die();
}

```

Remplacez "x.x.x.x" par l'adresse IP de votre OpenKarotz.

Toutes les fonctions de la classe retournent un tableau associatif. En cas d'erreur, l'index "retour" du tableau sera égal à 1 et l'index "msg" contiendra le message d'erreur.

S'il n'y a pas d'erreur, le tableau associatif sera le retour de l'API officielle (qui est au format JSON), décodé grâce à la fonction `json_decode()`.

---

Fonctions
---------

[](#fonctions)

### Informations

[](#informations)

#### getStatus()

[](#getstatus)

Vous retourne le status du lapin.

```
$out = $karotz->getStatus();

```

##### Exemple de retour :

[](#exemple-de-retour-)

```
Array
(
    [version] => 200
	[ears_disabled] => 0
	[sleep] => 0
	[sleep_time] => 0
	[led_color] => 00FF00
	[led_pulse] => 1
	[tts_cache_size] => 2
	[usb_free_space] => -1
	[karotz_free_space] => 147.3M
	[eth_mac] => 00:00:00:00:00:00
	[wlan_mac] => 00:0E:8E:2C:D4:98
	[nb_tags] => 1
	[nb_moods] => 305
	[nb_sounds] => 14
	[nb_stories] => 0
	[karotz_percent_used_space] => 37
	[usb_percent_used_space] =>
	[data_dir] => /usr/openkarotz
)

```

#### getStorage()

[](#getstorage)

Vous retourne l'espace utilisé sur la mémoire interne du lapin et la mémoire USB.

```
$out = $karotz->getStorage();

```

##### Exemple de retour :

[](#exemple-de-retour--1)

```
Array
(
	[karotz_percent_used_space] => 37
	[usb_percent_used_space] => -1
)

```

#### getList()

[](#getlist)

Vous retourne la liste de données spécifié.

```
$out = $karotz->getList($categorie);

```

La catégorie peut être "rfid", "rfidInfos" (contient une version lisible des valeurs `type` et `color`, voir l'*exemple de retour*, équivalent de `/cgi-bin/rfid_infos_ext` de l'API officielle), sound", "voice", "moods", "snapshot", "stories" ou "radio".

##### Exemple de retour :

[](#exemple-de-retour--2)

```
Array
(
	[tags] => Array
	(
		[0] => Array
		(
			[id] => D0021A053B4A21CB
			[name] =>
			[type] => KAROTZ
			[type_name] => KEYRING
			[color] => 4
			[color_name] => YELLOW
		)
	)
	[return] => 0
)

```

### État

[](#état)

#### wakeUp()

[](#wakeup)

Réveille le Karotz.

```
$out = $karotz->wakeUp([$silent = false]);

```

Si `$silent` vaut `true`, le Karotz se réveillera silencieusement.

##### Exemple de retour :

[](#exemple-de-retour--3)

```
Array
(
	[return] => 0
	[silent] => 1
)

```

#### sleep()

[](#sleep)

Endors le Karotz.

```
$out = $karotz->sleep();

```

### Leds

[](#leds)

#### led()

[](#led)

Change la couleur de la led du Karotz.

```
$out = $karotz->led([$color = '000000']);

```

La couleur doit être spécifié sous forme d'une chaîne hexadécimale.

##### Exemple de retour :

[](#exemple-de-retour--4)

```
Array
(
	[color] => FF0066
	[secondary_color] => 000000
	[pulse] => 0
	[no_memory] => 0
	[speed] =>
	[return] => 0
)

```

#### pulse()

[](#pulse)

Fait clignoter la led du Karotz.

```
$out = $karotz->pulse($primaryColor [, $secondaryColor = '000000' [, $speed = 700]]);

```

Les couleurs doivent être spécifiés sous forme d'une chaîne hexadécimale. La vitesse doit être comprise entre 0 et 2000.

##### Exemple de retour :

[](#exemple-de-retour--5)

```
Array
(
	[color] => FF0066
	[secondary_color] => 00FF00
	[pulse] => 1
	[no_memory] => 0
	[speed] => 1000
	[return] => 0
)

```

### Oreilles

[](#oreilles)

#### earsMode()

[](#earsmode)

Active ou désactive le mouvement des oreilles du Karotz.

```
$out = $karotz->earsMode([$disable = false]);

```

##### Exemple de retour :

[](#exemple-de-retour--6)

```
Array
(
	[return] => 0
	[disabled] => 1
)

```

#### ears()

[](#ears)

Modifie la position des oreilles du Karotz.

```
$out = $karotz->ears([$left = 0 [, $right = 0 [, $reset = false]]]);

```

Les positions $left ou $right vont de 0 à 16, vous pouvez cependant dépasser ou mettre une valeur négative si vous souhaitez faire plusieurs tours ou changer le sens de rotation par exemple.

Si `$reset` vaut `true`, les oreilles se mettront d'abord en position initiale avant de se positionner.

##### Exemple de retour :

[](#exemple-de-retour--7)

```
Array
(
	[left] => 13
	[right] => 18
	[return] => 0
)

```

#### earsReset()

[](#earsreset)

Réinitialise la position des oreilles.

```
$out = $karotz->earsReset();

```

#### earsRandom()

[](#earsrandom)

Positionne les oreilles de manière aléatoire.

```
$out = $karotz->earsRandom([$reset = false]);

```

Si `$reset` vaut `true`, les oreilles se mettrong d'abord en position initiale avant de se positionner.

### RFID

[](#rfid)

#### rfidStartRecord()

[](#rfidstartrecord)

Lance l'enregistrement des tags RFID.

```
$out = $karotz->rfidStartRecord();

```

**Attention** : Cette fonction ne retourne actuellement rien !

#### rfidStopRecord()

[](#rfidstoprecord)

Stoppe l'enregistrement des tags RFID.

```
$out = $karotz->rfidStopRecord();

```

#### rfidDelete()

[](#rfiddelete)

Supprime un tag RFID enregistré.

```
$out = $karotz->rfidDelete($id);

```

##### Exemple de retour :

[](#exemple-de-retour--8)

```
Array
(
	[return] => 0
	[tag] => D0021A053B4A21CB
)

```

#### rfidUnassign()

[](#rfidunassign)

Supprime l'action associée au tag RFID.

```
$out = $karotz->rfidUnassign($id);

```

##### Exemple de retour :

[](#exemple-de-retour--9)

```
Array
(
	[return] => 0
	[tag] => D0021A053B4A21CB
)

```

#### rfidAssignURL()

[](#rfidassignurl)

Assigne le tag RFID à un appel d'URL.

```
$out = $karotz->rfidAssignUrl($id, $url, $name)

```

### TTS (Text To Speech = Synthèse vocale)

[](#tts-text-to-speech--synthèse-vocale)

#### getCache()

[](#getcache)

Récupère le cache TTS du Karotz.

```
$out = $karotz->getCache();

```

##### Exemple de retour :

[](#exemple-de-retour--10)

```
Array
(
	[cache] => Array
	(
		[0] => Array
		(
			[id] => 4d509419511635e0fce55a929629fbbb
			[text] =>  Bonjour tout le monde !
			[voice] => claire
		)
	)
	[return] => 0
)

```

#### clearCache()

[](#clearcache)

Efface le cache TTS du Karotz.

```
$out = $karotz->clearCache();

```

##### Exemple de retour :

[](#exemple-de-retour--11)

```
Array
(
	[return] => 0
	[msg] => Cache cleared
)

```

#### say()

[](#say)

Fait parler le Karotz.

```
$out = $karotz->say($text [, $voice='claire' [, nocache = false]]);

```

$voice peut être `alice` (FR), `claire` (FR), `julie` (FR), `margaux` (FR), `antoine` (FR), `bruno` (FR), `louise` (CA), `justine` (BE), `heater` (US), `ryan` (US), `lucy` (UK), `graham` (UK), `andreas` (DE), `julia` (DE), `chiara` (IT) ou `Vittorio` (IT).

Si `$nocache` vaut `true`, le fichier audio ne sera pas sauvegardé dans le cache.

##### Exemple de retour :

[](#exemple-de-retour--12)

```
Array
(
	[id] => cfcb12bf12e8bccffe7e48c791e0b870
	[played] => 1
	[cache] => 0
	[return] => 0
	[voice] => alice
	[mute] => 0
)

```

### Photos

[](#photos)

#### clearSnapshots()

[](#clearsnapshots)

Efface toutes les photos enregistrées.

```
$out = $karotz->clearSnapshots();

```

#### takeSnapshot()

[](#takesnapshot)

Prends une photo depuis le Karotz.

```
$out = $karotz->takeSnapshot([$silent = true [, $ftp = false, $server, $user, $password, $remoteDirectory]]);

```

Si `$silent` vaut `false`, le lapin fera du bruit lors de la prise de photo.

Si `$ftp` vaut `true`, les paramètres `$server`, `$user`, `$password` et `$remoteDirectory` doivent absolument être renseignés. Ces champs ne vérifient pas la connexion ni la validité des données, faites donc bien attention aux valeurs que vous entrez !

`$server` est l'adresse du serveur FTP, `$user` l'identifiant, `$password` le mot de passe et `$remoteDirectory` le répertoire de sauvegarde de l'image.

### Sons

[](#sons)

#### play()

[](#play)

Joue un fichier audio enregistré sur le Karotz (vous pouvez obtenir la liste des fichiers audio enregistrés via la commande `getList('sound')`).

```
$out = play($id);

```

**Note** : `$id` est une chaîne de caractère, à savoir le nom du fichier audio, et non un entier !

#### playStream()

[](#playstream)

Joue un fichier audio ou un flux audio depuis internet.

```
$out = $karotz->playStream($url);

```

#### pause()

[](#pause)

Met en pause le fichier ou flux audio en cours de lecture, ou continue le morceau s'il est déjà en pause.

```
$out = $karotz->pause();

```

##### Exemple de retour :

[](#exemple-de-retour--13)

```
Array
(
	[return] => 0
	[cmd] => pause
)

```

**Note** : Pour le moment, la valeur de l'index `cmd` retourné sera toujours sur `pause`, on ne peut pas savoir si le morceau est déjà en pause.

#### stop()

[](#stop)

Quitte la lecture du fichier ou flux audio.

```
$out = $karotz->stop();

```

##### Exemple de retour :

[](#exemple-de-retour--14)

```
Array
(
	[return] => 0
	[cmd] => quit
)

```

#### squeezeboxStart()

[](#squeezeboxstart)

Lance la Squeezebox.

```
$out = $karotz->squeezeboxStart();

```

#### squeezeboxStop()

[](#squeezeboxstop)

Stoppe la Squeezebox.

```
$out = $karotz->squeezeboxStop();

```

### Applications

[](#applications)

#### playMood()

[](#playmood)

Joue une humeur sur le Karotz.

```
$out = $karotz->playMood([$id = NULL]);

```

Si `$id` n'est pas renseigné, une humeur aléatoire sera jouée.

##### Exemple de retour :

[](#exemple-de-retour--15)

```
Array
(
	[moods] => 279
	[return] => 0
)

```

#### playClock()

[](#playclock)

Joue une heure sur le Karotz.

```
$out = $karotz->playClock([$hour = NULL]);

```

Si `$hour` n'est pas renseigné, l'heure actuelle sera jouée.

##### Exemple de retour :

[](#exemple-de-retour--16)

```
Array
(
	[return] => 0
	[hour] => 20
)

```

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity40

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/ff5f6f8ccb79af6da6c1f312607a45c8803e76fdfe849f0a76a8f66c7d3dd365?d=identicon)[ayrel](/maintainers/ayrel)

---

Top Contributors

[![GilDev](https://avatars.githubusercontent.com/u/3149748?v=4)](https://github.com/GilDev "GilDev (4 commits)")

### Embed Badge

![Health badge](/badges/ayrel-karotz/health.svg)

```
[![Health](https://phpackages.com/badges/ayrel-karotz/health.svg)](https://phpackages.com/packages/ayrel-karotz)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M475](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M270](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M453](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)