API HTTP

Các chức năng sau đây cung cấp ánh xạ các Thanh ghi Modbus sang HTTP.
Lưu ý: Modbus không cần phải hoạt động để sử dụng HTTP API.

Sử dụng yêu cầu HTTP GET hoặc POST tới địa chỉ của cFos Power Brain Controller, ví dụ:
http://192.168.2.111/cnf?cmd=modbus&device=meter1&read=35154.
Các câu trả lời bằng JSON.

  • cmd luôn là modbus
  • device = meter1 hoặc meter2 hoặc evse
  • read = địa chỉ của sổ đăng ký để đọc
  • write = địa chỉ của sổ đăng ký để đọc
  • value = giá trị để viết
  • values = mảng các giá trị cần ghi, ví dụ [1,2,3,4]

Địa chỉ có thể có hậu tố để chỉ định kiểu dữ liệu (mặc định là số nguyên 16 bit):

  • d = số nguyên 32 bit (2 thanh ghi modbus)
  • q = số nguyên 64 bit (4 thanh ghi modbus)
  • s = chuỗi
Bộ điều khiển sạc cFos - Đăng ký Modbus

Dưới đây là một số ví dụ, cách sử dụng API HTTP

Modbus

/cnf?cmd=modbus&device=meter1&read=8002
Phản ứng:
1

/cnf?cmd=modbus&device=meter1&read=8062d
Phản ứng:
-1

/cnf?cmd=modbus&device=meter1&read=8016s
Phản ứng:
"cFos Power Brain"

/cnf?cmd=modbus&device=meter1&read=8002&count=10
Phản ứng:
[1,257,256,0,256,0,26211,26165,11619,13366]

/cnf?cmd=modbus&device=meter2&read=all
Phản ứng:
{"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
Phản ứng:
"ok"

/cnf?cmd=modbus&device=evse&write=8050q&value=1"
Phản ứng:
"ok"

/cnf?cmd=modbus&device=evse&write=8044d&value=1"
Phản ứng:
"bad modbus register size"

/cnf?cmd=modbus&device=evse&write=8044&values=[7,230,230,230 ]
Phản ứng:
"ok"

Yêu cầu chung

Yêu cầu trạng thái của tất cả các thiết bị Trình quản lý sạc:
/cnf?cmd=get_dev_info

Đặt mã PIN hoặc RFID:
/cnf?cmd=enter_rfid&rfid=r&dev_id=d
r là mã PIN hoặc RFID (chữ số), d là ID thiết bị tùy chọn để chọn một hộp treo tường cụ thể. Nếu không có id thiết bị nào được chọn, Trình quản lý sạc sẽ cố gắng chỉ định mã PIN hoặc RFID tự động.

Ghi đè cho giao dịch hiện tại:
/cnf?cmd=override_device&dev_id=d&flags=f&mamps=ma&rfid=id
d là ID thiết bị, id là RFID/PIN có thể được yêu cầu, các cờ như sau:
'C': Hủy kích hoạt tải (Yêu cầu/
'c': Hủy kích hoạt tải lại (Yêu cầu/
'E': Hủy kích hoạt các quy tắc tính phí của hộp treo tường (yêu cầu mật khẩu của quản trị viên)
'e': Hủy kích hoạt lại quy tắc tính phí của hộp treo tường (yêu cầu mật khẩu của quản trị viên)
'U': Hủy kích hoạt các quy tắc tính phí của người dùng (/mã PIN của người dùng)
'u': Hủy kích hoạt lại các quy tắc tính phí của người dùng (/mã PIN của người dùng)

Các cờ được đặt theo cách này được giữ lại cho đến khi xe được rút phích cắm khỏi hộp treo tường.

mamps=ma: Ghi đè (giới hạn) dòng sạc bằng ma mA.

Cài đặt đồng hồ đo năng lượng mô phỏng:
/cnf?cmd=soft_meter&dev_id=d&val=v
v (tùy chọn) là năng lượng được đặt trong Wh/VAh. Nếu v không tồn tại, bộ đếm chỉ được đọc. d là id thiết bị của EVSE. Giá trị trả về là số đọc bộ đếm cũ trước khi nó được đặt.

Bộ đếm HTTP và hộp treo tường

quầy tính tiền

Bạn có thể tạo bộ đếm (loại thiết bị 'Đầu vào HTTP') mà Trình quản lý sạc không thể đọc được, nhưng có thể chỉ định các giá trị hiện tại của nó bên ngoài bằng cách sử dụng HTTP POST hoặc GET:
/cnf?cmd=set_ajax_meter&dev_id=x
x là ID thiết bị như được thấy trong cấu hình thiết bị, ví dụ: M1.

Nội dung POST chứa một đối tượng JSON, như sau:

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

Giá trị năng lượng được tính bằng Wh hoặc VAh, điện áp tính bằng V, dòng điện tính bằng mA và công suất tính bằng W hoặc VA. "is_va" true hoặc false cho biết nguồn được chỉ định bằng W hay VA. "model" là chuỗi mô hình như được hiển thị trong các ô. power_w là tùy chọn. Power_va được sử dụng nếu power_w không được thông qua.

Một số người dùng của chúng tôi (#diebestenuserderwelt) sử dụng công cụ cuộn tròn để cung cấp dữ liệu cho bộ đếm, ví dụ:
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], "power_va": 2000 }' --user admin:1234abcd 'http://192.168.2.111/cnf?cmd=set_ajax_meter&dev_id=M3'

Là một HTTP GET, yêu cầu được viết như sau:
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&power_va=2000

Đây là một mục diễn đàn khác để kết nối đồng hồ thông minh bằng đồng hồ đo đầu vào cFos HTTP và ioBroker.

Hộp tường

Bạn cũng có thể tạo một hộp âm tường (loại thiết bị 'Đầu vào HTTP'), hộp này không được Trình quản lý sạc đọc ra hoặc kiểm soát, nhưng có thể chỉ định các giá trị bên ngoài bằng HTTP POST hoặc GET. Các giá trị điều khiển sau đó được trả về dưới dạng phản hồi:
/cnf?cmd=set_ajax_evse&dev_id=x
x là ID thiết bị như được thấy trong cấu hình thiết bị, ví dụ: E1.

Nội dung POST chứa một đối tượng JSON, như sau:

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

"model" là chuỗi mô hình như được hiển thị trong các ô. Với "rfid", bạn có thể thêm RFID vào quá trình sạc, giá trị năng lượng được tính bằng Wh, dòng tính bằng mA. "state" có các giá trị sau:
1 = chờ (A), 2 = EV hiện tại (B), 3 = sạc (C), 4 = sạc có thông gió (D), 5 = lỗi (E)

Là một HTTP GET, yêu cầu được viết như sau:
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

Đáp lại, yêu cầu này trả về đối tượng JSON sau:

{
   "device_enabled": true/false, // thiết bị được bật/tắt
   "Charge_enabled": true/false, // được phép sạc / không được phép
   "tạm dừng": true/false, // true = thiết bị tạm thời bị tạm dừng
   "Charge_current": số // dòng sạc được chỉ định tính bằng mA
}

Đối tượng trả về này phải được đánh giá bởi người gọi và EVSE phải được đặt cho phù hợp, ví dụ: dòng sạc phải được thay đổi tương ứng.

Web interface (English)

All requests return an answer in JSON. Values marked with r/o are read-only. Please note: We do not guarantee the stability of this API. Functionality, parameters, values, etc. may change without notice.

Retrieve info about load-balancing and all devices

/cnf?cmd=get_dev_info
Return value (sample):
{
"params" : {
"title" : "cFos Power Brain",
"desc" : "Standard-Konfiguration",
"max_total_power" : 22000,   // total installed power in W
"power_reserve" : 0,   // power reserve (subtracted from max_total_power)       
"overdraft" : 0,       // generated overdraft, can be set to 0
"max_total_evse_power" : 0,   // max power available to all EVSEs
"consumed_evse_power" : 0,    // r/o, consumed EVSE power in W
"remaining_evse_power" : 22000,   // r/o, remaining 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_power" : 11040,   // maximum charging power in W
"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" : 0,   // current power (active or apparent) in W or VA
"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
}
]
}
         

Get/set Charging Manager parameters

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

HTTP GET get_params returns a JSON object, HTTP POST set_params needs a JSON object in the message body


Return value (sample):
//         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",
}         
         

Set device configuration

/cnf?cmd=set_params
POST payload (sample):
{
   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
   ]
}
         

Get / set user info

/cnf?cmd=get_users
/cnf?cmd=get_user
/cnf?cmd=set_user
*** ml: String not found [name='cfos_cm_sample_resp']:
:
// get_user retrieves a single user object, set_user POSTs a single user object, get_users retrieves an array of user objects
// set_user may be called without admin password if it contains a valid user ID, creation of new users requires admin access

[   // 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
]
}
]
         

Accept license:
/cnf?cmd=accept_license&acc=1&allow_usage_stats=a
a = 1 allow reporting of usage stats to cFos eMobililty, a = 0 disallow

Change admin password:
/cnf?cmd=change_admin_pwd&old_pwd=old&new_pwd=new
old, new are the old and new admin password

Delete a device:
/cnf?cmd=del_device&dev_id=d
d is a valid device ID

Get a unique user ID (for creation of a new user):
/cnf?cmd=get_new_user_id
returns a new user ID as a JSON string

Reset a device:
/cnf?cmd=reset_device&dev_id=d
d is a valid device ID. The device will be destroyed and re-created

Start stop diagnose logging:
/cnf?cmd=set_diag_logging&enable=e
e = 1 to start, e = 0 to stop diagnose logging. Runs for 5 minutes if not stopped