ocpp.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Linumiz
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_OCPP_H_
#define ZEPHYR_INCLUDE_NET_OCPP_H_
 
#include <stdio.h>
#include <zephyr/kernel.h>
#include <zephyr/net/net_ip.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define CISTR50 50
 
enum ocpp_auth_status {
        OCPP_AUTH_INVALID,      
        OCPP_AUTH_ACCEPTED,     
        OCPP_AUTH_BLOCKED,      
        OCPP_AUTH_EXPIRED,      
        OCPP_AUTH_CONCURRENT_TX 
};
 
enum ocpp_notify_reason {
        OCPP_USR_GET_METER_VALUE,
 
        OCPP_USR_START_CHARGING,
 
        OCPP_USR_STOP_CHARGING,
 
        OCPP_USR_UNLOCK_CONNECTOR,
};
 
enum ocpp_meter_measurand {
        OCPP_OMM_CURRENT_FROM_EV,               
        OCPP_OMM_CURRENT_TO_EV,                 
        OCPP_OMM_CURRENT_MAX_OFFERED_TO_EV,     
        OCPP_OMM_ACTIVE_ENERGY_FROM_EV,         
        OCPP_OMM_ACTIVE_ENERGY_TO_EV,           
        OCPP_OMM_REACTIVE_ENERGY_FROM_EV,       
        OCPP_OMM_REACTIVE_ENERGY_TO_EV,         
        OCPP_OMM_ACTIVE_POWER_FROM_EV,          
        OCPP_OMM_ACTIVE_POWER_TO_EV,            
        OCPP_OMM_REACTIVE_POWER_FROM_EV,        
        OCPP_OMM_REACTIVE_POWER_TO_EV,          
        OCPP_OMM_POWERLINE_FREQ,                
        OCPP_OMM_POWER_FACTOR,                  
        OCPP_OMM_POWER_MAX_OFFERED_TO_EV,       
        OCPP_OMM_FAN_SPEED,                     
        OCPP_OMM_CHARGING_PERCENT,              
        OCPP_OMM_TEMPERATURE,                   
        OCPP_OMM_VOLTAGE_AC_RMS,                
        OCPP_OMM_END
};
 
union ocpp_io_value {
 
        struct {
                int id_con;
 
                enum ocpp_meter_measurand mes;
 
                char val[CISTR50];
        } meter_val;
 
        struct {
                char idtag[CISTR50];    
                int id_con;
        } start_charge;
 
        struct {
                int id_con;     
        } stop_charge;
 
        struct {
                int id_con;     
        } unlock_con;
};
 
struct ocpp_cp_info {
        char *model;            
        char *vendor;           
        int num_of_con;         
        char *sl_no;            
        char *box_sl_no;        
        char *fw_ver;           
        char *iccid;            
        char *imsi;             
        char *meter_sl_no;      
        char *meter_type;       
};
 
struct ocpp_cs_info {
        char *cs_ip;    
        char *ws_url;   
        int port;       
        sa_family_t sa_family; 
};
 
typedef void *ocpp_session_handle_t;
 
typedef int (*ocpp_user_notify_callback_t)(enum ocpp_notify_reason reason,
                                           union ocpp_io_value *io,
                                           void *user_data);
 
int ocpp_init(struct ocpp_cp_info *cpi,
              struct ocpp_cs_info *csi,
              ocpp_user_notify_callback_t cb,
              void *user_data);
 
int ocpp_session_open(ocpp_session_handle_t *hndl);
 
void ocpp_session_close(ocpp_session_handle_t hndl);
 
int ocpp_authorize(ocpp_session_handle_t hndl,
                   char *idtag,
                   enum ocpp_auth_status *status,
                   uint32_t timeout_ms);
 
int ocpp_start_transaction(ocpp_session_handle_t hndl,
                           int meter_val,
                           uint8_t conn_id,
                           uint32_t timeout_ms);
 
int ocpp_stop_transaction(ocpp_session_handle_t hndl,
                          int meter_val,
                          uint32_t timeout_ms);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_NET_OCPP_H_ */