Difference between revisions of "Glossary"
Jump to navigation
Jump to search
(Add charge cards to glossary) |
|||
| (13 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
== CDR == | == CDR == | ||
| − | It stands for ''Charge Detail | + | It stands for ''Charge Detail Record'' it's an object sent from [[Glossary#CPO|CPO]] s to us once a charge is over. |
| − | ====== | + | ====== Information stored ====== |
| − | * The | + | * The timestamp of the start of the charge (when the [[Glossary#POC|POC]] starts delivering energy) |
| − | * The | + | * The timestamp of the end of the charge (when the [[Glossary#POC|POC]] stops delivering energy, when the user stops the charge or when the car is charged for example) |
| − | * The | + | * The timestamp of the start of the session (when user asks for a charge to start) |
| + | * The timestamp of the end of the session (when user detached the cable) | ||
| + | * The energy consumption in kWh | ||
* The penalty duration | * The penalty duration | ||
| − | * The | + | * The reason why the charge ended ([[Glossary#Remote stop|remote stop]], unplug the cable,...) |
| + | * The session id of the charge | ||
| + | * Authentication data to trace the user who charged | ||
| − | ====== Key concepts | + | ====== Key concepts ====== |
* It can arrive only after that the user detached the cable | * It can arrive only after that the user detached the cable | ||
| − | * | + | * Usually it takes some seconds to some minutes for it to arrive. Sometimes, when [[Glossary#CPO|CPO]] has errors, it can take hours or days or it can happen that the ''CDR'' doesn't arrive at all. This is totally out of our control |
| − | * It's the only way we have to tell users how much they have to pay. During the charge we see of course some consumption data and costs, but the only reliable way to know how much a user has to pay is the CDR | + | * It's the only way we have to tell users how much they have to pay. During the charge we see of course some consumption data and costs, but the only reliable way to know how much a user has to pay is the ''CDR'' |
| − | |||
| − | <small> | + | Little example of the last part of the flow:<blockquote><small>... -></small> |
| − | <small> | + | <small>User detaches the cable -></small> |
| − | == | + | <small>After an unpredictable time our api receives the ''CDR'' from the [[Glossary#CPO|CPO]] -></small> |
| − | It's | + | |
| + | <small>From now on we can notify the user that he has to pay, the amount, the consumption, the penalty (if present), ecc...</small></blockquote> | ||
| + | |||
| + | == Charge card == | ||
| + | Charge cards are issued by the [[Glossary#MSP|MSP]] and assigned univocally to single users. | ||
| + | |||
| + | Every card has an 8-digit ''external code'' printed on it. | ||
| + | |||
| + | Every card has a 14-digit hexadecimal ''uid'' stored in the ROM of the MIFARE chip. It's the internal code of the issuer of the card, it allows the mapping between cards and user | ||
| − | + | Cards can assume different statuses (ACTIVE, IDLE, BLOCKED, DISABLED (permanently)) | |
| − | |||
== Charge statuses == | == Charge statuses == | ||
| − | |||
* PENDING | * PENDING | ||
* BOOKED | * BOOKED | ||
| Line 43: | Line 52: | ||
* COMPLETED | * COMPLETED | ||
| − | == | + | == CPO == |
| − | + | '''C'''harging '''P'''oint '''O'''perator: a company who makes [[Glossary#CU|CU]] s and [[Glossary#POC|POC]] s available to [[Glossary#MSP|MSP]]. Sometimes ''CPO'' s can incorporate their own [[Glossary#MSP|MSP]]. For example, Enel is a ''CPO'' and a [[Glossary#MSP|MSP]] at the same time, owning their own mobile application, Juice Pass | |
| + | |||
| + | == CU == | ||
| + | '''C'''harging '''U'''nit: a charging station comprehending one or more [[Glossary#POC|POC]] s | ||
| + | |||
| + | == Evse Id == | ||
| + | It identifies univocally a [[Glossary#POC|POC]]. It can contain the [[Glossary#Serial number|serial number]] | ||
| + | |||
| + | == MSP == | ||
| + | '''M'''obility '''S'''ervice '''P'''rovider: a company who buys energy (in our case) from a [[Glossary#CPO|CPO]] and sells it to final users providing the software infrastructure (usually mobile applications) to keep trace of their consumptions, payments, ecc... | ||
| + | |||
| + | == POC == | ||
| + | '''P'''oint '''O'''f '''C'''harge: the electrical socket where users plug the cable. A ''POC'' can be part of a [[Glossary#CU|charging station]] | ||
| + | |||
| + | == Remote start == | ||
| + | It's an operation performed by the user mobile app to start a charge | ||
| + | |||
| + | == Remote stop == | ||
| + | It's an operation performed by the user mobile app to stop a charge | ||
| − | + | == Serial Number == | |
| + | It identifies univocally a [[Glossary#CU|CU]] | ||
Latest revision as of 16:02, 25 June 2021
CDR[edit | edit source]
It stands for Charge Detail Record it's an object sent from CPO s to us once a charge is over.
Information stored[edit | edit source]
- The timestamp of the start of the charge (when the POC starts delivering energy)
- The timestamp of the end of the charge (when the POC stops delivering energy, when the user stops the charge or when the car is charged for example)
- The timestamp of the start of the session (when user asks for a charge to start)
- The timestamp of the end of the session (when user detached the cable)
- The energy consumption in kWh
- The penalty duration
- The reason why the charge ended (remote stop, unplug the cable,...)
- The session id of the charge
- Authentication data to trace the user who charged
Key concepts[edit | edit source]
- It can arrive only after that the user detached the cable
- Usually it takes some seconds to some minutes for it to arrive. Sometimes, when CPO has errors, it can take hours or days or it can happen that the CDR doesn't arrive at all. This is totally out of our control
- It's the only way we have to tell users how much they have to pay. During the charge we see of course some consumption data and costs, but the only reliable way to know how much a user has to pay is the CDR
Little example of the last part of the flow:
... ->
User detaches the cable ->
After an unpredictable time our api receives the CDR from the CPO ->
From now on we can notify the user that he has to pay, the amount, the consumption, the penalty (if present), ecc...
Charge card[edit | edit source]
Charge cards are issued by the MSP and assigned univocally to single users.
Every card has an 8-digit external code printed on it.
Every card has a 14-digit hexadecimal uid stored in the ROM of the MIFARE chip. It's the internal code of the issuer of the card, it allows the mapping between cards and user
Cards can assume different statuses (ACTIVE, IDLE, BLOCKED, DISABLED (permanently))
Charge statuses[edit | edit source]
- PENDING
- BOOKED
- LOCALLY_BOOKED
- FAILED
- EXPIRED
- ACTIVE
- STAND_BY
- STAND_BY_WITH_PENALTY
- STOPPED
- STOPPED_WITH_PENALTY
- DELETED
- COMPLETED
CPO[edit | edit source]
Charging Point Operator: a company who makes CU s and POC s available to MSP. Sometimes CPO s can incorporate their own MSP. For example, Enel is a CPO and a MSP at the same time, owning their own mobile application, Juice Pass
CU[edit | edit source]
Charging Unit: a charging station comprehending one or more POC s
Evse Id[edit | edit source]
It identifies univocally a POC. It can contain the serial number
MSP[edit | edit source]
Mobility Service Provider: a company who buys energy (in our case) from a CPO and sells it to final users providing the software infrastructure (usually mobile applications) to keep trace of their consumptions, payments, ecc...
POC[edit | edit source]
Point Of Charge: the electrical socket where users plug the cable. A POC can be part of a charging station
Remote start[edit | edit source]
It's an operation performed by the user mobile app to start a charge
Remote stop[edit | edit source]
It's an operation performed by the user mobile app to stop a charge
Serial Number[edit | edit source]
It identifies univocally a CU