HTTP API

下列函式提供 HTTP 中 Modbus 暫存器的映射。
注意：使用 HTTP API 時，Modbus 無需啟動。

使用 HTTP GET 或 POST 請求至 cFos Charging Controller 的位址，例如
http://192.168.2.111/cnf?cmd=modbus&device=meter1&read=35154。
回應是 JSON 格式。

• cmd永遠是modbus
• 裝置=meter1或meter2或evse
• read= 讀取暫存器的位址
• write= 要寫入的暫存器位址
• value= 要寫入的值
• values= 要寫入的數值陣列，例如[1,2,3,4]

位址可以有後綴來指定資料類型 (預設為16 位元整數)：

• d= 32 位元整數（2 個 Modbus 暫存器）
• q= 64 位元整數（4 個 Modbus 暫存器）
• s= 字串

以下是一些使用 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"

一般要求

查詢所有 Charging Manager 裝置的狀態：
/cnf?cmd=get_dev_info

設定 PIN 或 RFID：
/cnf?cmd=enter_rfid&rfid=r&dev_id=d
r 是 PIN 或 RFID（位數），d 是可選的裝置 ID，用於選擇特定的壁掛盒。如果未選擇裝置 ID，充電管理程式會嘗試自動指定 PIN 或 RFID。

覆寫目前的交易：
/cnf?cmd=override_device&dev_id=d&flags=f&mamps=ma&rfid=id
d 是裝置 ID，id 是可能需要的 RFID/PIN，旗標，如下所示：
'C「: 停用充電 (需要管理員密碼或使用者 PIN/RFID)
」c「: 再次停用充電 (需要管理員密碼或使用者 PIN/RFID)
」E「: 停用壁掛盒的充電規則 (需要管理員密碼)
」e「: 再次停用壁掛盒的充電規則 (需要管理員密碼)
」U'：停用使用者的充電規則 (需要使用者 RFID/PIN)
'u': 再次停用使用者的充電規則 (需要使用者 RFID/PIN)

以這種方式設定的標誌會保留，直到汽車從 wallbox 拔下為止。

mamps=ma: 以 ma mA 覆寫（限制）充電電流。

設定模擬能量計：
/cnf?cmd=soft_meter&dev_id=d&val=v
v（可選）是要設定的能量，單位為 Wh/VAh。d 是 wallbox 的裝置 ID。回傳值是設定前的舊計量表讀數。

HTTP 電錶和壁掛盒

計數器

您可以建立一個計數器（裝置類型「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 為單位。"model "是磁磚中顯示的模型字串。

我們的一些使用者 (#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 連接智慧型計量表。

牆盒

您也可以建立一個 wallbox（裝置類型「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
         }

"model" 是模型字串，如圖片所示。使用 "rfid"，您可以為充電程序指定 RFID，能量值以 Wh 為單位，電流以 mA 為單位。"state" 有下列值：
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": true/false, // 裝置已啟用/停用
            "charging_enabled": true/false, // 允許/不允許充電
            "paused": true/false, // true = 裝置暫時停用
            "charging_current": number // 指定的充電電流，單位為 mA
         }

呼叫者必須評估此回傳物件，並相應地設定 wallbox，例如，充電電流必須相應地改變。

網頁介面

所有請求都會回傳 JSON 格式的回應。標示 r/o 的值為唯讀。請注意：我們不保證此 API 的穩定性。功能、參數、值等若有變更，恕不另行通知。

擷取負載平衡及所有裝置的相關資訊

         {
         "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 EVSE 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
         }
         ]
         }
                  

設定/讀取充電管理員參數

HTTP GETget_params會傳回一個 JSON 物件，
HTTP POSTset_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",
         }         
                  

設定裝置設定

         {
            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

get_user 擷取單一使用者物件，
set_userPOST 單一使用者物件，
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
         ]
         }
         ]
                  

接受授權

變更管理員密碼

刪除裝置

擷取唯一使用者 ID (用於建立新使用者)

重設裝置

開始/停止診斷記錄