HTTP API

Fungsi-fungsi berikut ini menyediakan pemetaan Modbus Registers ke HTTP.
Catatan: Modbus tidak perlu aktif untuk menggunakan HTTP API.

Gunakan permintaan HTTP GET atau POST ke alamat cFos Power Brain Controller, misalnya
http://192.168.2.111/cnf?cmd=modbus&device=meter1&read=35154.
Tanggapan dalam JSON.

  • cmd selalu modbus
  • perangkat = meter1 atau meter2 atau evse
  • read = alamat register yang akan dibaca
  • tulis = alamat register yang akan dibaca
  • value = nilai yang akan ditulis
  • values = array nilai yang akan ditulis, misalnya [1,2,3,4]

Alamat dapat memiliki akhiran untuk menentukan tipe data (defaultnya adalah 16 bit integer):

  • d = 32 bit integer (2 register modbus)
  • q = 64 bit integer (4 register modbus)
  • s = string
pengontrol Pengisian cFos - Register Modbus

Berikut ini beberapa contoh, cara menggunakan HTTP API

Modbus

/cnf?cmd=modbus&device=meter1&read=8002
Tanggapan:
1

/cnf?cmd=modbus&device=meter1&read=8062d
Tanggapan:
-1

/cnf?cmd=modbus&device=meter1&read=8016s
Tanggapan:
"cFos Power Brain"

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

/cnf?cmd=modbus&device=meter2&read=all
Tanggapan:
{"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
Tanggapan:
"ok"

/cnf?cmd=modbus&device=evse&write=8050q&value=1"
Tanggapan:
"ok"

/cnf?cmd=modbus&device=evse&write=8044d&value=1"
Tanggapan:
"bad modbus register size"

/cnf?cmd=modbus&device=evse&write=8044&values=[7,230,230,230 ]
Tanggapan:
"ok"

Permintaan Umum

Meminta status semua perangkat Charging Manager:
/cnf?cmd=get_dev_info

Mengatur PIN atau RFID:
/cnf?cmd=enter_rfid&rfid=r&dev_id=d
r adalah PIN atau RFID (digit), d adalah id perangkat opsional untuk memilih EVSE tertentu. Jika tidak ada id perangkat yang dipilih, Manajer Pengisian Daya mencoba menetapkan PIN atau RFID secara otomatis.

Timpa untuk transaksi saat ini:
/cnf?cmd=override_device&dev_id=d&flags=f&mamps=ma&rfid=id
d adalah ID perangkat, id adalah RFID/PIN yang mungkin diperlukan, flag, sebagai berikut:
'C': Nonaktifkan pengisian daya (Admin pwd atau PIN Pengguna/RFID diperlukan)
'c': Nonaktifkan pengisian daya lagi (Admin pwd atau PIN Pengguna/RFID diperlukan)
'E': Nonaktifkan aturan pengisian daya EVSE (Diperlukan pwd Admin)
'e': Nonaktifkan kembali aturan pengisian EVSE (Diperlukan pwd Admin)
'U': Menonaktifkan aturan pengisian daya pengguna (diperlukan RFID/PIN pengguna)
'u': Nonaktifkan kembali aturan pengisian daya pengguna (diperlukan RFID/PIN pengguna)

Bendera yang ditetapkan dengan cara ini tetap ada sampai mobil dicabut dari EVSE.

mamps=ma: Timpa (batasi) arus pengisian dengan ma mA.

Mengatur meteran energi simulasi:
/cnf?cmd=soft_meter&dev_id=d&val=v
v (opsional) adalah energi yang akan diatur dalam Wh/VAh. Jika v tidak ada, meteran hanya dibaca. d adalah id perangkat EVSE. Nilai yang dikembalikan adalah pembacaan meteran lama sebelum pengaturan.

HTTP meter dan EVSE

Meteran

Anda dapat membuat meteran (tipe perangkat 'HTTP Input') yang tidak dibaca oleh Manajer Pengisian Daya, tetapi yang nilainya saat ini dapat ditentukan secara eksternal melalui HTTP POST atau GET:
/cnf?cmd=set_ajax_meter&dev_id=x
x adalah ID perangkat seperti yang terlihat dalam konfigurasi perangkat, misalnya M1.

Badan POST berisi objek JSON, sebagai berikut:

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

Nilai energi diberikan dalam Wh atau VAh, tegangan dalam V, arus dalam mA dan daya dalam W atau VA. "is_va" true atau false menunjukkan apakah daya ditentukan dalam W atau VA. "model" adalah string model seperti yang ditunjukkan pada ubin. power_w adalah opsional. Power_va digunakan jika power_w tidak dilewatkan.

Beberapa pengguna kami (#diebestenuserderwelt) menggunakan alat curl untuk memasok data ke meteran, mis:
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'

Sebagai HTTP GET, permintaan ditulis seperti ini:
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

Berikut ini adalah posting forum lain tentang menghubungkan smart meter menggunakan cFos HTTP input meter dan ioBroker.

EVSE

Anda juga dapat membuat wallbox (tipe perangkat 'HTTP Input') yang tidak dibaca atau dikontrol oleh Manajer Pengisian Daya, tetapi nilainya dapat ditentukan secara eksternal menggunakan HTTP POST atau GET. Nilai kontrol kemudian dikembalikan sebagai respons:
/cnf?cmd=set_ajax_evse&dev_id=x
x adalah ID perangkat seperti yang terlihat dalam konfigurasi perangkat, misalnya E1.

Badan POST berisi objek JSON, sebagai berikut:

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

"model" adalah string model seperti yang ditunjukkan pada ubin. Dengan "rfid" Anda dapat menambahkan RFID ke proses pengisian daya, nilai energi diberikan dalam Wh, arus dalam mA. "state" memiliki nilai berikut:
1 = menunggu (A), 2 = ada EV (B), 3 = pengisian daya (C), 4 = pengisian daya dengan ventilasi (D), 5 = kesalahan (E)

Sebagai HTTP GET, permintaan ditulis seperti ini:
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

Sebagai tanggapan, permintaan ini mengembalikan objek JSON berikut:

{
    "device_enabled": true/false, // perangkat diaktifkan/disabled
    "charging_enabled": true/false, // pengisian daya diperbolehkan / tidak diperbolehkan
    "paused": true/false, // true = perangkat dijeda sementara
    "charging_current": nomor // arus pengisian yang ditentukan dalam mA
}

Objek yang dikembalikan ini harus dievaluasi oleh pemanggil dan EVSE harus diatur sesuai dengan itu, misalnya arus pengisian harus diubah sesuai dengan itu.

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