文档

HTTP的应用程序编程接口（API）

以下函数提供了Modbus寄存器与HTTP的映射。
注意：使用HTTP API时，Modbus不需要激活。

使用HTTP GET或POST请求到cFos收费控制器的地址，例如：
http://192.168.2.111/cnf?cmd=modbus&device=meter1&read=35154。
响应为JSON格式。

  • cmd总是modbus
  • 设备=meter1或meter2或evse
  • read= 要读取的寄存器的地址
  • 写= 要读的寄存器的地址
  • 值=要写的值
  • values= 要写的数值数组，例如[1,2,3,4]。

地址可以有一个后缀来指定数据类型（默认是16位整数）。

  • d= 32位整数（2个modbus寄存器）。
  • q= 64位整数（4个modbus寄存器）。
  • s=字符串
cFos充电控制器 - Modbus寄存器

下面是一些例子，如何使用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，用于选择特定的EVSE。如果没有选择设备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':再次禁用充电（需要管理员权限或用户PIN/RFID）
'E':禁用EVSE充电规则（需要管理员pwd）
'e':再次禁用EVSE充电规则（需要管理员pwd）
'U':停用用户的充电规则（需要用户的RFID/PIN）
'u':再次停用用户的充电规则（需要用户的RFID/PIN）

以这种方式设置的标志保持到汽车从EVSE上拔下插头。

mamps=ma:用ma mA覆盖（限制）充电电流。

设置模拟的能量表。
/cnf?cmd=soft_meter&dev_id=d&val=v
v（可选）是要设置的能量，单位是Wh/VAh。如果v不存在，只读取电表。d是EVSE的设备ID。返回值是设置前的旧电表读数。

HTTP电表和EVSE

仪表

你可以创建一个仪表（设备类型为 "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连接智能表的论坛帖子。

EVSE

你也可以创建一个墙盒（设备类型 "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=电动车存在（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, // 设备已启用/禁用
            "charge_enabled": true/false, // 允许/不允许充电
            "paused": true/false, // true = 设备暂时暂停使用
            "charging_current": number // 指定的充电电流，单位为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 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",
         }

设置设备设置

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

接受许可证

/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
old,new分别是新旧管理员密码

删除设备

/cnf?cmd=del_device&dev_id=d
d是有效的设备 ID

读取唯一的用户 ID（创建新用户）

/cnf?cmd=get_new_user_id
以 JSON 字符串形式返回新用户 ID

重置设备

/cnf?cmd=reset_device&dev_id=d
d是有效的设备 ID。设备被删除并重新创建

开始/停止诊断记录

/cnf?cmd=set_diag_logging&enable=e
e=1表示启动，e=0表示停止诊断记录。如果未停止，则运行 5 分钟