nrf_edgeai_runtime.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
#ifndef _NRF_EDGEAI_RUNTIME_H_
#define _NRF_EDGEAI_RUNTIME_H_
 
#include <nrf_edgeai/rt/nrf_edgeai_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/***********************************************************************************************************************
 * nRF Edge AI runtime public API
 ***********************************************************************************************************************/
 
nrf_edgeai_err_t nrf_edgeai_init(nrf_edgeai_t* p_edgeai);
 
nrf_edgeai_err_t nrf_edgeai_feed_inputs(nrf_edgeai_t* p_edgeai,
                                        void*         p_input_values,
                                        uint16_t      num_values);
 
nrf_edgeai_err_t nrf_edgeai_run_inference(nrf_edgeai_t* p_edgeai);
 
/***********************************************************************************************************************
Utility variables and functions
***********************************************************************************************************************/
 
nrf_edgeai_input_type_t nrf_edgeai_input_type(const nrf_edgeai_t* p_edgeai);
 
uint16_t nrf_edgeai_uniq_inputs_num(const nrf_edgeai_t* p_edgeai);
 
uint16_t nrf_edgeai_input_window_size(const nrf_edgeai_t* p_edgeai);
 
uint8_t nrf_edgeai_input_subwindows_num(const nrf_edgeai_t* p_edgeai);
 
uint16_t nrf_edgeai_model_outputs_num(const nrf_edgeai_t* p_edgeai);
 
nrf_edgeai_model_type_t nrf_edgeai_model_type(const nrf_edgeai_t* p_edgeai);
 
nrf_edgeai_model_task_t nrf_edgeai_model_task(const nrf_edgeai_t* p_edgeai);
 
const char* nrf_edgeai_solution_id_str(const nrf_edgeai_t* p_edgeai);
 
nrf_edgeai_rt_version_t nrf_edgeai_solution_runtime_version(const nrf_edgeai_t* p_edgeai);
 
nrf_edgeai_rt_version_t nrf_edgeai_runtime_version(void);
 
bool nrf_edgeai_is_runtime_compatible(const nrf_edgeai_t* p_edgeai);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _NRF_EDGEAI_RUNTIME_H_ */