ANNEXES
ANNEXE 1
PARAMÈTRES COMMUNIQUÉS PAR L'API

1. Paramètres principaux

Les paramètres principaux sont transmis par l'IAD (pour Integrated Access Device) à un outil de mesure de qualité de service à la suite d'une requête effectuée une seule fois lorsqu'un utilisateur réalise un test de mesure de la qualité de service internet.

| Condition de présence | Arbre JSON |Nom du paramètre|Unité| Détail du paramètre | Format / liste de valeurs acceptées | |------------------------------------------|-----------------|----------------|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------| | Obligatoire | Root | ApiVersion | | Version de l'API | Entier positif de 64 bits | | Facultatif | Gateway | Model | | Nom de l'IAD (« box ») du client | texte | | Facultatif | Gateway |SoftwareVersion | | Version du logiciel | texte | | Obligatoire lorsque défini et existant |SubscriptionSpeed| DownloadMin |Kb/s | Débit minimum descendant contractuel | Entier positif de 64 bits | | Obligatoire lorsque défini et existant |SubscriptionSpeed| UploadMin |Kb/s | Débit minimum montant contractuel | Entier positif de 64 bits | | Obligatoire |SubscriptionSpeed| DownloadMax |Kb/s | Débit maximum descendant contractuel | Entier positif de 64 bits | | Obligatoire |SubscriptionSpeed| UploadMax |Kb/s | Débit maximum montant contractuel | Entier positif de 64 bits | | Obligatoire lorsque défini et existant |SubscriptionSpeed|DownloadNormally|Kb/s | Débit « normalement disponible » descendant contractuel (s'il existe) | Entier positif de 64 bits | | Obligatoire lorsque défini et existant |SubscriptionSpeed| UploadNormally |Kb/s | Débit « normalement disponible » montant contractuel (s'il existe) | Entier positif de 64 bits | | Obligatoire | Wan | Technology | | Technologie WAN utilisée par l'IAD (« box ») | ["ftth" ;"adsl" ; "vdsl" ;"gfast" ;"cable" ;"satellite" ;"2g" ;"3g" ;"4g" ;"5g" ;"other"] | |Obligatoire si la technologie WAN est FTTH| Wan/SpeedOnt | Download |Kb/s |FTTH uniquement : débit descendant Ethernet entre l'ONT et l'IAD.
Facultatif : Si détection d'un CPL sur le port WAN : débit brut remonté par le CPL.| Entier positif de 64 bits | |Obligatoire si la technologie WAN est FTTH| Wan/SpeedOnt | Upload |Kb/s | FTTH uniquement : débit montant Ethernet entre l'ONT et l'IAD
Facultatif : Si détection d'un CPL sur le port WAN : débit brut remonté par le CPL. | Entier positif de 64 bits | |Obligatoire si la technologie WAN est FTTH| Wan/SpeedOnt | Duplex | | FTTH uniquement : mode Ethernet entre l'ONT et l'IAD | ["half" ;"full"] | |Obligatoire si la technologie WAN est xDSL|Wan/SpeedSynchro | Download |Kb/s | xDSL uniquement : débit de synchronisation descendant | Entier positif de 64 bits | |Obligatoire si la technologie WAN est xDSL|Wan/SpeedSynchro | Upload |Kb/s | xDSL uniquement : débit de synchronisation montant | Entier positif de 64 bits | | Obligatoire | Wan | Aggregation | | Technologie WAN secondaire active
"no" : absence d'agrégation ou agrégation non activée. |["no" ;"ftth" ;"adsl" ; "vdsl" ;"gfast" ;"cable" ;"satellite" ;"2g" ;"3g" ;"4g" ;"5g" ;"other"]|

Nota. - le « débit maximum » est à remplir systématiquement avec les technologies WAN FTTH, câble et satellite avec le débit contractuel. Pour les autres technologies WAN, il n'est à remplir que si l'accès possède un débit maximum.

| Condition de présence | Arbre JSON |Nom du paramètre|Unité| Détail du paramètre | Format / liste de valeurs acceptées | |--------------------------------------------|-------------|----------------|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------| | Obligatoire | Lan | ConnectionType | | Technologie pour joindre l'IAD utilisée par le terminal requêtant l'API.
Note : La détection du CPL sur le LAN est facultative. | ["wifi" ;"ethernet" ;"cpl" ; "other"] | | Obligatoire |Lan/SpeedLan | DownloadMax |Kb/s | Débit maximal théorique de l'interface. Ethernet/CPL : capacité du port Ethernet coté box d'où provient la requête de l'API. Wi-Fi : débit maximum théorique proposé par le Wi-Fi de la box. | Entier positif de 64 bits | | Obligatoire |Lan/SpeedLan | Download |Kb/s |Débit descendant sur le LAN (Ethernet / Wi-Fi / CPL) négocié par le terminal requêtant l'API.
CPL : débit brut remonté par le CPL connecté sur le port Ethernet d'où provient la requête de l'API.| Entier positif de 64 bits | | Obligatoire |Lan/SpeedLan | UploadMax | | Débit maximal théorique de l'interface. Ethernet/CPL : capacité du port Ethernet coté box d'où provient la requête de l'API. Wi-Fi : débit maximum théorique proposé par le Wi-Fi de la box. | Entier positif de 64 bits | | Obligatoire |Lan/SpeedLan | Upload |Kb/s | Débit montant sur le LAN (Ethernet / Wi-Fi / CPL) négocié par le terminal requêtant l'API. | Entier positif de 64 bits | |Obligatoire si la connexion LAN est Ethernet|Lan/SpeedLan | Duplex | | Ethernet half-duplex ou full-duplex | ["half" ;"full"] | | Obligatoire si la connexion LAN est Wi-Fi | Lan/Wifi | IeeeMax | | Norme Wi-Fi IEEE 802.11 la plus élevée, supportée par la box. |Entier positif (802.11a=>1 802.11b=>2 802.11g=> 3
802.11n=>4 802.11ac=>5
802.11ax=>6)| | Obligatoire si la connexion LAN est Wi-Fi | Lan/Wifi | Ieee | | Norme Wi-Fi IEEE 802.11 négociée entre l'IAD et le terminal requêtant l'API. |Entier positif (802.11a=>1 802.11b=>2 802.11g=> 3
802.11n=>4 802.11ac=>5
802.11ax=>6)| | Obligatoire si la connexion LAN est Wi-Fi | Lan/Wifi | RadioBand | | Bande radio Wi-Fi utilisée par le terminal requêtant l'API.
Bloc de fréquence de 2,4 GHz ou bloc de fréquence de 5 GHz. | Entier positif :
Bande 2,4 Ghz => 2 Bande 5 Ghz => 5 | | Obligatoire si la connexion LAN est Wi-Fi | Lan/Wifi | Rssi | dBm | Mesure de la puissance d'un signal radio reçu. C'est le Rssi du terminal requêtant l'API. | Entier positif de 64 bits | | Facultatif |Miscellaneous| Other[1…n] | | Autres paramètres que l'opérateur souhaite transmettre aux outils de mesure. | |

Nota. - certains adaptateurs CPL (7) ne peuvent pas être détectés par l'IAD, de même que les connexions Wi-Fi initiées depuis un point d'accès tiers connecté en Ethernet à l'IAD.

2. Paramètres liés au cross-traffic

Ces paramètres sont spécifiques au cross-traffic. Ils sont récupérés par l'outil de mesure de qualité de service à la suite de deux requêtes effectuées :

- immédiatement après que le client ait lancé le test de mesure de la qualité de service internet ;
- immédiatement après que l'outil de mesure ait terminé la mesure de la qualité de service internet.

L'outil détermine la présence de cross-traffic si le nombre d'octets sur l'interface WAN est significativement supérieur au nombre d'octets générés par le test de mesure de la qualité de service en lui-même.
Optionnellement, un compteur pour le cross-traffic LAN peut être mis en place. Il permet de détecter la présence de cross-traffic ayant un impact côté LAN.

|Condition de présence| Arbre JSON |Nom du paramètre|Unité | Détail du paramètre |Format / liste de valeurs acceptées| |---------------------|---------------|----------------|------|-----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------| | Obligatoire | TimeStamp | ApiCallTime | | Horodatage correspondant à l'heure à laquelle l'API est requêtée | Entier positif de 64 bits | | Obligatoire | TimeStamp | LastUpdate | |Horodatage de la dernière mise à jour du compteur du port WAN (le compteur est relevé en temps réel alors LastUpdate = ApiCallTime)| Entier positif de 64 bits | | Obligatoire |Wan/ByteCounter| Download |Octets| Relevé du compteur de trafic descendant (internet => IAD) du port WAN | Entier positif de 64 bits | | Obligatoire |Wan/ByteCounter| Upload |Octets| Relevé du compteur de trafic montant (IAD => internet) du port WAN | Entier positif de 64 bits | | Facultatif |Lan/ByteCounter| Download |Octets| Relevé du compteur de trafic descendant (IAD => Terminal utilisateur) du port LAN | Entier positif de 64 bits | | Facultatif |Lan/ByteCounter| Upload |Octets| Relevé du compteur de trafic montant (Terminal utilisateur => IAD) du port LAN | Entier positif de 64 bits |

Dans le cas où l'IAD ne peut pas remonter l'information d'un compteur du nombre d'octets sur le port WAN ou LAN, il conviendra d'utiliser le compteur de paquets multiplié par la MTU (Maximum Transmission Unit) afin de fournir une approximation.
Si le trafic « hors internet » (essentiellement le trafic TV/VoD) est à l'extérieur du débit Internet, avec une bande passante dédiée, alors les compteurs de cross-traffic ne remontent que les octets liés au trafic internet.
Si le trafic « hors internet » impacte le débit maximum sur internet, ce qui correspond à une enveloppe globale utilisée pour l'un ou l'autre, alors les compteurs de cross-traffic remontent les octets sur le port WAN, en incluant le trafic TV/VoD.

(7) Courants porteurs en ligne : équipement qui permet de transporter internet par le réseau électrique à l'intérieur d'une habitation à la place d'un câble Ethernet ou du Wi-Fi.