以下の機能は、Modbus レジスタと HTTP のマッピングを提供します。
注:HTTP API を使用するために Modbus がアクティブである必要はありません。
cFos Power Brain Controller のアドレスに HTTP GET または POST リクエスト(例:
http://192.168.2.111/cnf?cmd=modbus&device=meter1&read=35154)
レスポンスは JSON 形式です。
cmdは
常にModbusdevice
=meter1またはmeter2またはevseread
= 読み出すべきレジスタのアドレスwrite
= 読み出すレジスタのアドレスvalue
= 書き込む値values
= 書き込む値の配列、例:[1,2,3,4]。アドレスにはデータ型を指定するサフィックスを付けることができる(デフォルトは16ビット整数)。
d
= 32ビット整数 (2つのModbusレジスタ)q
= 64ビット整数 (4つのModbusレジスタ)s
= 文字列/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 は特定の EVSE を選択するためのオプションのデバイス 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':充電を再び無効にする (Admin pwd または User PIN/RFID が必要)
'E':EVSE 充電ルールを無効にする (Admin pwd が必要)
'e':EVSE 充電ルールを再び無効にする (Admin pwd が必要)
'U':ユーザーの充電ルールを無効にする (ユーザー RFID/PIN が必要)
'u':この方法で設定したフラグは、車が EVSE から取り外されるまで残ります。充電電流を ma mA で上書き(制限)する。
模擬エネルギーメーターを設定する。/cnf?cmd=soft_meter&dev_id=d&val=v
v(オプション)は、設定するエネルギーをWh/VAhで指定します。v がない場合は、メーターの読み取りのみとなります。 d は EVSE のデバイス ID です。戻り値は、設定前の古いメーターの読み値です。
充電マネージャでは読み取れないが、HTTP POSTまたはGETで外部から現在値を指定できるメータ(デバイスタイプ 'HTTP Input')を作成することができます。/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¤t=10001,10002,10003
cFos HTTP入力 メーターとioBrokerを 使ったスマートメーターの接続について、別のフォーラムの投稿を紹介します。
また、充電マネージャでは読み取りや制御を行わないが、HTTP POSTやGETで外部から値を指定できるウォールボックス(デバイスタイプ 'HTTP Input')を作成することもできます。そして、その制御値をレスポンスとして返す。/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¤t=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)。 }
このリターンオブジェクトは呼び出し側で評価され、それに応じて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
{ 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 ] }
/cnf?cmd=get_users
/cnf?cmd=get_user
/cnf?cmd=set_user
get_userは単一のユーザーオブジェクトを取得します。
set_userは単一のユーザーオブジェクトを POST します。
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
/cnf?cmd=change_admin_pwd&old_pwd=alt&new_pwd=neu
/cnf?cmd=del_device&dev_id=d
/cnf?cmd=get_new_user_id
/cnf?cmd=reset_device&dev_id=d
/cnf?cmd=set_diag_logging&enable=e