Документација

HTTP API

Следните функции обезбедуваат мапирање на регистрите на Modbus на HTTP.
Забелешка: Modbus не треба да биде активен за да го користи HTTP API.

Користете барање HTTP GET или POST на адресата на cFos Power Brain Controller, на пр
http://192.168.2.111/cnf?cmd=modbus&device=meter1&read=35154.
Одговорите се во JSON.

  • cmd е секогаш модбус
  • device = метар1 или метар2 или есе
  • read = адреса на регистарот за читање
  • write = адреса на регистарот што треба да се прочита
  • value = вредност што треба да се напише
  • values = низа вредности што треба да се напишат, на пр. [1,2,3,4]

Адресите можат да имаат наставка за одредување на типот на податок (стандардно е 16-битен цел број):

  • d = 32-битен цел број (2 регистри на модбус)
  • q = 64-битен цел број (4 регистри на модбус)
  • s = стринг
cFos контролер за полнење - Регистри на Модбус

Еве неколку примери, како да го користите HTTP API

Modbus

/cnf?cmd=modbus&device=meter1&read=8002
Одговор:
1

/cnf?cmd=modbus&device=meter1&read=8062d
Одговор:
-1

/cnf?cmd=modbus&device=meter1&read=8016s
Одговор:
"cFos Power Brain"

/cnf?cmd=modbus&device=meter1&read=8002&count=10
Одговор:
[1,257,256,0,256,0,26211,26165,11619,13366]

/cnf?cmd=modbus&device=meter2&read=all
Одговор:
{"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
Одговор:
"ok"

/cnf?cmd=modbus&device=evse&write=8050q&value=1"
Одговор:
"ok"

/cnf?cmd=modbus&device=evse&write=8044d&value=1"
Одговор:
"bad modbus register size"

/cnf?cmd=modbus&device=evse&write=8044&values=[7,230,230,230 ]
Одговор:
"ok"

Општи барања

Побарајте ја состојбата на сите уреди на Менаџерот за полнење:
/cnf?cmd=get_dev_info

Поставување PIN или RFID:
/cnf?cmd=enter_rfid&rfid=r&dev_id=d
r е PIN или RFID (цифри), d е изборно ID на уредот за избор на одредено wallидно сандаче. Ако не е избран ID на уредот, Менаџерот за полнење се обидува автоматски да додели PIN или RFID.

Пребришете за тековната трансакција:
/cnf?cmd=override_device&dev_id=d&flags=f&mamps=ma&rfid=id
d е ID на уредот, id е веројатно потребен RFID/PIN, означува како што следува:
'C': деактивирајте го вчитувањето (потребно е администратор pwd или кориснички PIN/RFID)
'c': деактивирајте го повторното вчитување (потребно е администратор pwd или кориснички PIN/RFID)
'E': деактивирајте ги правилата за полнење на wallbox (потребно е администратор pwd)
'e': повторно деактивирајте ги правилата за полнење на wallbox (потребна е административна pwd)
„U“: деактивирајте ги правилата за полнење на корисникот (/PIN за корисникот)
'u': повторно деактивирајте ги правилата за полнење на корисникот (потребно е RFID/PIN на корисникот)

Вака поставените знамиња се задржуваат додека автомобилот не се исклучи од ѕидното сандаче.

mamps=ma: Презапишете (ограничете ја) струјата на полнење со ma mA.

Поставување на симулираниот мерач на енергија:
/cnf?cmd=soft_meter&dev_id=d&val=v
v (опционално) е енергијата што треба да се постави во Wh/VAh. Ако v не постои, бројачот само се чита. d е ID на уредот на EVSE. Повратната вредност е старото читање на бројачот пред да се постави.

Бројачи на HTTP и wallидни кутии

бројач

Можете да креирате бројач (тип на уред „Влез HTTP“) што не се чита од Управникот за полнење, но чии моментални вредности може да се наведат надворешно користејќи HTTP POST или GET:
/cnf?cmd=set_ajax_meter&dev_id=x
x е ID на уредот, како што се гледа во конфигурацијата на уредот, на пр. M1.

Телото POST содржи JSON објект, како што следува:

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

Енергетските вредности се дадени во Wh, напоните во V, струите во mA и моќноста во W. „модел“ е стрингот на моделот како што е прикажано во плочките.

Некои од нашите корисници (#diebestenuserderwelt) ја користат алатката curl за да го снабдуваат бројачот со податоци, на пр.
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'

Како HTTP GET, барањето е напишано вака:
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

Еве уште еден запис на форумот за поврзување паметен мерач со помош на влезен мерач cFos HTTP и ioBroker.

Волбокс

Можете исто така да креирате ѕидна кутија (тип на уред „Влез HTTP“), која не се чита или контролира од Управникот за полнење, но чии вредности може да се наведат надворешно користејќи HTTP POST или GET. Контролните вредности потоа се враќаат како одговор:
/cnf?cmd=set_ajax_evse&dev_id=x
x е ID на уредот како што се гледа во конфигурацијата на уредот, на пр. E1.

Телото POST содржи JSON објект, како што следува:

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

„модел“ е низата на моделот како што е прикажано на плочките. Со „rfid“ можете да додадете RFID во процесот на полнење, енергетските вредности се дадени во Wh, струите во mA. „држава“ ги има следниве вредности:
1 = чекање (A), 2 = EV присутно (B), 3 = полнење (C), 4 = полнење со вентилација (D), 5 = грешка (E)

Како HTTP GET, барањето е напишано вака:
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

Како одговор, ова барање го враќа следниот објект JSON:

{
            "device_enabled": точно/неточно, // уредот е овозможен/оневозможен
            „полнење_овозможено“: точно/неточно, // дозволено е полнење / не е дозволено
            „пауза“: точно/неточно, // точно = уредот е привремено паузиран
            "струја на полнење": број // одредена струја на полнење во mA
         }

Овој повратен објект мора да се процени од страна на повикувачот и EVSE мора да се постави соодветно, на пр. Струјата на полнење мора да се смени соодветно.

Веб интерфејс

Сите барања враќаат одговор во JSON. Вредностите означени r/o се само за читање. Ве молиме имајте предвид: ние не ја гарантираме стабилноста на овој API. Функционалноста, параметрите, вредностите итн. се предмет на промена без претходна најава.

Добијте информации за балансерот на оптоварување и сите уреди

/cnf?cmd=get_dev_info
Врати вредности (пример):
         {
         "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
         }
         ]
         }
                  

Поставете/прочитајте ги параметрите на Управникот за полнење

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

HTTP GET get_params враќа JSON објект,
HTTP POST set_params бара објект JSON во телото на пораката

Врати вредности (пример):
         //         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",
         }         
                  

Поставете ги поставките на уредот

/cnf?cmd=set_params
POST носивост (пример):
         {
            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 добива еден кориснички објект,
set_user објавува единечен кориснички објект,
get_users добива низа од кориснички објекти
set_user може да се пристапи без административна лозинка ако содржи важечки кориснички ID. Создавањето нови корисници бара администраторски пристап

Врати вредности (пример):
         [   // 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
         ]
         }
         ]
                  

Прифатете лиценца

/cnf?cmd=accept_license&acc=1&allow_usage_stats=a
a = 1 дозволува статистиката за користење да се пријави на cFos eMobililty, a = 0 го забранува

Променете ја административната лозинка

/cnf?cmd=change_admin_pwd&old_pwd=alt&new_pwd=neu
стари и нови се старите и новите администраторски лозинки

Избришете уред

/cnf?cmd=del_device&dev_id=d
d е важечки ID на уредот

Добијте единствен кориснички ID (за создавање нов корисник)

/cnf?cmd=get_new_user_id
враќа нов кориснички ID како низа JSON

Ресетирајте уред

/cnf?cmd=reset_device&dev_id=d
d е важечки ID на уредот. Уредот ќе биде избришан и повторно создаден

Започнете/прекинете со дијагностичко логирање

/cnf?cmd=set_diag_logging&enable=e
e = 1 за почеток, e = 0 за запирање на дијагностичкото евидентирање. Работи 5 минути ако не запре