Documentation

API HTTP

Les fonctions suivantes fournissent un mappage des registres Modbus à HTTP.
Remarque: Modbus n'a pas besoin d'être actif pour utiliser l'API HTTP.

Utilisez une requête HTTP GET ou POST à l'adresse du cFos Power Brain Controller, par exemple
http://192.168.2.111/cnf?cmd=modbus&device=meter1&read=35154.
Les réponses sont en JSON.

  • cmd est toujours modbus
  • dispositif = compteur1 ou compteur2 ou evse
  • read = adresse du registre à lire
  • write = adresse du registre à lire
  • valeur = valeur à écrire
  • values = tableau de valeurs à écrire, par exemple [1,2,3,4]

Les adresses peuvent avoir un suffixe pour spécifier le type de données (par défaut, un entier de 16 bits) :

  • d = nombre entier de 32 bits (2 registres modbus)
  • q = nombre entier de 64 bits (4 registres modbus)
  • s = chaîne
contrôleur de charge cFos - Registres Modbus

Voici quelques exemples d'utilisation de l'API HTTP

Modbus

/cnf?cmd=modbus&device=meter1&read=8002
Réponse :
1

/cnf?cmd=modbus&device=meter1&read=8062d
Réponse :
-1

/cnf?cmd=modbus&device=meter1&read=8016s
Réponse :
"cFos Power Brain"

/cnf?cmd=modbus&device=meter1&read=8002&count=10
Réponse :
[1,257,256,0,256,0,26211,26165,11619,13366]

/cnf?cmd=modbus&device=meter2&read=all
Réponse :
{"8000d":-821755904,"8002":1,"8003":257,"8004":16777216,"8006":256,"8007":0,"8008s":"fcf5-c46d-310c","8016s":"cFos Power Brain","8040":41,"8041":1,"8042d":1000,"8044":1,"8045":230,"8046":230,"8047":230,"8050q":0,"8054d":0,"8056":0,"8057":0,"8058q":0,"8062d":-1,"8064d":0,"8066d":0,"8068d":0,"8070":0,"8071":0,"8120d":0}

/cnf?cmd=modbus&device=evse&write=8044&value=7
Réponse :
"ok"

/cnf?cmd=modbus&device=evse&write=8050q&value=1"
Réponse :
"ok"

/cnf?cmd=modbus&device=evse&write=8044d&value=1"
Réponse :
"bad modbus register size"

/cnf?cmd=modbus&device=evse&write=8044&values=[7,230,230,230 ]
Réponse :
"ok"

Demandes générales

Demande l'état de tous les appareils du gestionnaire de charge :
/cnf?cmd=get_dev_info

Réglage d'un code PIN ou RFID :
/cnf?cmd=enter_rfid&rfid=r&dev_id=d
r est le PIN ou RFID (chiffres), d est un ID de dispositif optionnel pour sélectionner un EVSE spécifique. Si aucun identifiant de dispositif n'est sélectionné, le Charging Manager tente d'attribuer le PIN ou le RFID automatiquement.

Écraser pour la transaction en cours :
/cnf?cmd=override_device&dev_id=d&flags=f&mamps=ma&rfid=id
d est l'ID du dispositif, id est un RFID/PIN éventuellement requis, des drapeaux, comme suit :
'C' : Désactiver le chargement (Admin pwd ou User PIN/RFID requis)
'c' : Désactiver à nouveau la charge (Admin pwd ou User PIN/RFID requis)
'E' : Désactiver les règles de charge EVSE (Admin pwd requis)
'e' : Désactiver à nouveau les règles de charge EVSE (Admin pwd requis)
'U' : Désactiver les règles de charge de l'utilisateur (RFID/PIN utilisateur requis)
'u' : Désactiver à nouveau les règles de charge de l'utilisateur (RFID/PIN de l'utilisateur requis)

Les drapeaux définis de cette manière restent en place jusqu'à ce que la voiture soit débranchée de l'EVSE.

mamps=ma: Écraser (limiter) le courant de charge avec ma mA.

Réglage du compteur d'énergie simulée :
/cnf?cmd=soft_meter&dev_id=d&val=v
v (facultatif) est l'énergie à définir en Wh/VAh. Si v n'est pas présent, le compteur est seulement lu. d est l'identifiant du dispositif de l'EVSE. La valeur de retour est l'ancien relevé du compteur avant le réglage.

Compteurs HTTP et EVSEs

Compteur

Vous pouvez créer un compteur (type d'appareil 'HTTP Input') qui ne sera pas lu par le Charging Manager, mais dont les valeurs actuelles peuvent être fournies de l'extérieur au moyen de HTTP POST ou GET :
/cnf?cmd=set_ajax_meter&dev_id=x
x est l'identifiant du dispositif tel qu'il apparaît dans la configuration du dispositif, par exemple M1.

Le corps du POST contient un objet JSON, comme suit :

{
            "model": string,
            "import_vah": number,
            "export_wh": number,
            "voltage": [v1, v2, v3],
            "current": [c1, c2, c3],
            "power_w": number
            "is_va": bool
         }

Les valeurs d'énergie y sont indiquées en Wh, les tensions en V, les courants en mA et les puissances en W. "model" est la chaîne de modèle, telle qu'elle est affichée dans les carreaux.

Certains de nos utilisateurs (#diebestenuserderwelt) utilisent l'outil curl pour alimenter le compteur en données, par exemple :
curl -i -X POST -H 'Content-Type: application/json' -d '{ "model": "TestModell", "import_wh": 12345, "export_wh": 23456, "voltage": [231, 232, 233], "current": [10001, 10002, 10003] }' --user admin:1234abcd 'http://192.168.2.111/cnf?cmd=set_ajax_meter&dev_id=M3'

En HTTP GET, la requête s'écrit ainsi :
http://192.168.2.111/cnf?cmd=set_ajax_meter&dev_id=M3&model=TestModell&import_wh=12345&export_wh=23456&voltage=231,232,233&current=10001,10002,10003

Voici un autre message du forum sur la connexion d'un compteur intelligent à l'aide de cFos HTTP input meters et ioBroker.

EVSE

Vous pouvez également créer une Wallbox (type d'appareil 'HTTP Input') qui n'est pas lue ou commandée par le Charging Manager, mais dont les valeurs peuvent être données de l'extérieur au moyen de HTTP POST ou GET. Les valeurs de contrôle sont alors renvoyées comme réponse :
/cnf?cmd=set_ajax_evse&dev_id=x
x est l'identifiant du dispositif tel qu'il apparaît dans la configuration du dispositif, par exemple E1.

Le corps du POST contient un objet JSON, comme suit :

{
            "state": number,
            "max_charging_current": number,
            "current": [c1, c2, c3],
            "total_energy": number,
            "model": string,
            "rfid": string
         }

"model" est la chaîne de caractères du modèle comme indiqué dans les tuiles. Avec "rfid" vous pouvez ajouter une RFID au processus de charge, les valeurs d'énergie sont données en Wh, les courants en mA. "state" a les valeurs suivantes :
1 = attente (A), 2 = VE présent (B), 3 = charge (C), 4 = charge avec ventilation (D), 5 = erreur (E)

En HTTP GET, la requête s'écrit ainsi :
http://192.168.2.111/cnf?cmd=set_ajax_evse&dev_id=M3&model=TestModell&state=st&max_charging_current=m&current=c1,c2,c3&total_energy=t&rfid=r

En réponse, cette demande renvoie l'objet JSON suivant :

{
             "device_enabled" : true/false, // le dispositif est activé/désactivé
             "charging_enabled" : true/false, // facturation autorisée / non autorisée
             "paused" : true/false, // true = le dispositif est temporairement en pause
             "charging_current" : nombre // courant de charge spécifié en mA
         }

Cet objet de retour doit être évalué par l'appelant et l'EVSE doit être réglé en conséquence, par exemple, le courant de charge doit être modifié en conséquence.

Interface web

Toutes les requêtes renvoient une réponse en JSON. Les valeurs marquées r/o sont en lecture seule. Veuillez noter : nous ne garantissons pas la stabilité de cette API. Les fonctionnalités, paramètres, valeurs, etc. peuvent être modifiés sans préavis.

Consultation d'informations sur l'équilibrage de la charge et sur tous les appareils

/cnf?cmd=get_dev_info
Valeurs de retour (exemple) :
         {
         "params" : {
         "title" : "cFos Power Brain",
         "desc" : "Standard-Konfiguration",
         "max_total_current" : 32000,   // total installed power in mA
         "reserve_current" : 0,   // reserve in mA (subtracted from max_total_current)       
         "overdraft_cur" : 0,       // generated overdraft in mA, can be set to 0
         "max_total_evse_current" : 0,   // max current available to all EVSEs in mA
         "cons_evse_power" : 0,    // r/o, consumed EVSE power in W
         "avail_evse_power" : 32000,   // r/o, available EVSE power in W
         "lb_enabled" : false,   // true: load balancing enabled, false: disabled (observation mode)
         "disable_policy" : 1,   // on device disable: 0 disable EVSE, 1 use min. charging current, -1 remove charging current limit (free charging)
         "cycle_time" : 3009,   // current update cycle time in msec
         "max_evses" : 3,   // maximum number of licensed EVSEs
         "shareware_mode" : false,   // false, if licensed, true if trial version
         "version" : "1.8.1095",
         "time" : 1645281534,   // current time stamp
         "vsn" : 
         {
         "vendorid" : 52997,   // cFos
         },
         "ocpp_gateway_license_cnt" : 0,  // number of licensed OCPP gateways
         "ocpp_gateway_licenses_used" : 0   // number of used OCPP gateways
         },
         "devices" : [   // array of configured devices
         {
         "dev_type" : "evse_powerbrain",   // a sample EVSE
         "device_enabled" : 1,   // 1 = device enabled, 0 = disabled
         "name" : "Wallbox",   // config item: name
         "address" : "evse",   // address: URL, IP address or COM Port + Parameters
         "id" : 1,   // Modbus ID
         "dev_id" : "E1",   // unique device ID, EVSE always begin with E
         "number" : 1,   // config item: number
         "desc" : "cFos Power Brain Wallbox 11kW",   // config item: description
         "com_err" : false,   // true, if active communication error
         "com_err_secs" : 1404660,   // time since last com error
         "com_errors" : 0,   // number of com errors
         "last_error" : "",   // text of last error
         "is_evse" : true,   // true for EVSEs, false for meters
         "used_phases" : 0,   // 0=determine, otherwise bitfield: bit0 L1, bit1 L2, bit2 L3
         "label" : "",   // config item: text displayed when plugged in
         "min_charging_cur" : 6000,   // minimum charging current in mA
         "max_charging_cur" : 11040,   // maximum charging current in mA or expression
         "prio" : 1,   // charging priority
         "charging_enabled" : true,   // r/o, true if charging allowed
         "cur_charging_power" : 0,   // r/o, current charging power in W
         "total_energy" : 7120572,   // r/o, total used charging energy in Wh
         "phases" : 0,   // currently used phases, bitfield: bit0 L1, bit1 L2, bit2 L3
         "state" : 1,   // 1 = waiting for EV, 2 = EV presend, 3 = charging, 4 = charging/vent, 5 = error, 6 = offline
         "model" : "cFos Power Brain,1.0,1.8.1095,6d-31-0c",   // r/o, model string: Manufacturer,device,device version, firmware version, serial number
         "paused" : false,   // true, if device paused due to energy shortage or phase imbalance
         "pause_time" : 300,   // current elapsed pause time in secs
         "pause_min_time" : 300,   // min. secs before end of pause
         {
         "dev_type" : "meter_powerbrain",  // a sample meter
         "device_enabled" : 1,   // 1 = device enabled, 0 = disabled
         "name" : "S0 Zähler 1",   // config item: name
         "address" : "meter1",   // address: URL, IP address or COM Port + Parameters
         "id" : 2,   // Modbus ID
         "dev_id" : "M1",   // unique device ID, meters always begin with M
         "number" : 1,   // config item: number
         "desc" : "cFos Power Brain, S0 Zähler 1",   // config item: description
         "com_err" : false,   // true, if active communication error
         "com_err_secs" : 1404660,   // time since last com error
         "com_errors" : 0,   // number of com errors
         "last_error" : "",   // text of last error
         "is_evse" : true,   // true for EVSEs, false for meters
         "used_phases" : 0,   // 0=determine, otherwise bitfield: bit0 L1, bit1 L2, bit2 L3
         "is_va" : false,   // true if display is VA, false for W
         "invert" : false,   // if true, current and power values are inverted
         "import" : 15,   // imported energy in Wh
         "export" : 0,   // exported energy in Wh
         "power_w" : 0,   // current active power in W
         "current_l1" : 0,   // current L1 in mA
         "current_l2" : 0,   // current L2 in mA
         "current_l3" : 0,   // current L3 in mA
         "voltage_l1" : 230,   // Voltage L1 in V
         "voltage_l2" : 230,   // Voltage L2 in V
         "voltage_l3" : 230,   // Voltage L31 in V
         "role" : 0,   // 0 = display, 1 = consumption, 2 = production, 3 = grid demand, 4 = vehicle consumption, 5 = storage
         "model" : "cFos Power Brain,1.0,1.8.1095,6d-31-0c"   // r/o, model string: Manufacturer,device,device version, firmware version, serial number
         }
         ]
         }
                  

Définir/lire les paramètres du Charging Manager

/cnf?cmd=get_params
/cnf?cmd=set_params

HTTP GET get_params fournit un objet JSON,
HTTP POST set_params nécessite un objet JSON dans le texte du message

Valeurs de retour (exemple) :
         //         see values for get_dev_info.
         //        In Addition there is a device meta struct to allow for selection of device types:
         "dev_meta": 
         {
         "evse_powerbrain" : "cFos Power Brain",   // EVSE device type : name
         "evse_mennekes_modbus" : "Heidelberg Energy Control",
         "meter_elenker_meter" : "ModbusMeter 5A",   // meter device type : name
         "meter_kostal_powermeter" : "Kostal Powermeter",
         "meter_orno_we516" : "Orno OR-WE-516",
         }         
                  

Définir les réglages de l'appareil

/cnf?cmd=set_params
Données utiles POST (exemple):
         {
            devices: [   // array of device objects, currently may only contain 1 device
            {   // for most of the device properties, see get_dev_info
         attach: ""   // device ID of an attached meter
         battery_save_threshold: 0   // in mA, if charging current falls below this threshold, charging will be stopped, 0 = disable
         charging_rules: [   // array of charging rules
         // charging rules are work in progress, expect frequent changes to their object layout.
         {
            "days": d,     // d is a bitfields a weekdays: bit0 Monday...bit6 Sunday
            "mode": m,     // m mode of the rule: 0=absolule current, 1=relative current, 2=current solar current, 3=relative current solar current, 4=solar current minus current value, 5=solar surplus
            "current": c,  // c current in mA
            "enabled": e,  // e = true for an active rule, false for ignored rules
            "udur": u,     // u = undercut duration in secs
            "time": t      // t in minutes after midnight (for time based rules)
            "dur":  dur    // dur in minutes (for time based rules)
            "expr": expr   // expr is evaluated to determine the rule current (for expression rules)
            "input": in    // in = string specifying the input and level (for input based rules)
            "price_level", p   // p = price level (for cost baseed rules)
            "solar": s     // solar current in mA (for solar based rules)
         }
         ]
         enable_snooze: true   // true, allow device snooze
         enable_wakeup: true   // true, allow device wakeup for charging
         fixed_rfid: ""   // use fixed RFID for OCPP
         group: 0   // device belongs to this group, 0 = main group
         ocpp_gateway_client_id: "CP42"
         phase_rotation: 0
         soft_meter: 7120572   // estimated charged energy in W (if device has no meter)
         users: ["1170223812"]   // array of user ids which are allowed to charge at this EVSE
            ]
         }
                  

Benutzerinformationen setzen/auslesen

/cnf?cmd=get_users
/cnf?cmd=get_user
/cnf?cmd=set_user

get_user récupère un objet utilisateur unique,
set_user POSTet un objet utilisateur unique,
get_users récupère un tableau d'objets utilisateurs
set_user peut être appelé sans mot de passe admin s'il contient un ID utilisateur valide. La création de nouveaux utilisateurs nécessite un accès admin

Valeurs de retour (exemple):
         [   // array of users
         {
         "id" : "2167520770",   // unique user ID
         "name" : "wusel",   // name
         "display" : true,   // true if user may be displayed while plugged in
         "dev_ids" :    // EVSEs the user may use
         [
         "E1"
         ],
         "rfids" : 
         [   // array of RFIDs
         {
         "id" : "4711",   // RFID / PIN
         "name" : "TeSt",   // Name
         "ac_auth" : true,   // true: used to authorize
         "ac_ovch" : false,  // true: used to stop charging
         "used_phases" : 7   // used to override used phases, 0 = don't override
         }
         ],
         "charging_rules" : 
         [   // array of charging rules for this user
         ]
         }
         ]
                  

Accepter la licence

/cnf?cmd=accept_license&acc=1&allow_usage_stats=a
a = 1 autorise la communication de statistiques d'utilisation à cFos eMobililty, a = 0 l'interdit

Modifier le mot de passe admin

/cnf?cmd=change_admin_pwd&old_pwd=alt&new_pwd=neu
ancien, nouveau sont l'ancien et le nouveau mot de passe admin

Supprimer un appareil

/cnf?cmd=del_device&dev_id=d
d est un identifiant de périphérique valide

Récupération d'un ID utilisateur unique (pour créer un nouvel utilisateur)

/cnf?cmd=get_new_user_id
renvoie un nouvel ID utilisateur sous forme de chaîne JSON

Réinitialiser un appareil

/cnf?cmd=reset_device&dev_id=d
d est un identifiant de périphérique valide. L'appareil est supprimé et recréé

Démarrage/arrêt de l'enregistrement des diagnostics

/cnf?cmd=set_diag_logging&enable=e
e = 1 pour démarrer, e = 0 pour arrêter l'enregistrement du diagnostic. Fonctionne pendant 5 minutes si non stoppé