Introduction, Purpose of this document, Keapi overview – Kontron KEAPI User Manual

Page 5: Architectural overview, 1introduction, 1 purpose of this document, 2 keapi overview, 3 architectural overview

Advertising
background image

Software specification for Kontron EAPI

5

1

Introduction

1.1 Purpose of this document

This document describes Kontron Embedded API

– a software library that enables programmers to

easily create their applications for monitoring and control hardware resources of Kontron boards,
modules, systems and platforms.

1.2 KEAPI overview

KEAPI is written in C language and distributed as a dynamic-linked library so it can be used by
arbitrary application developed in C, C++ or higher programming languages simply by linking to the
project.

KEAPI library provides a set of functions for

Obtaining basic information about the system

CPU performance control

Temperature and voltage sensors monitoring

Monitoring and control of fans

Display backlight control

Access to EEPROM user storage area

I2C and SMBus communication

GPIO control

Watchdog


All KEAPI functions can be called remotely from another computer over network (TCP/IP).

KEAPI is compatible with PICMG EAPI specification (

http://www.picmg.org/pdf/COM_EAPI_R1_0.pdf

).

This means that it implements all functions defined by this specification. However, these functions
offer just a small part of KEAPI functionalities

and don’t allow remote connection.

1.3 Architectural overview

Kontron EAPI is a layer between Kontron hardware and user application. KEAPI functions either use
hardware drivers and operating system calls to perform requested operation on local board or
connects to KEAPI server that is installed on remote board somewhere on the internet. The KEAPI
server application listens on a predefined port (default is 7890) and waits for incoming request. When
the request comes, it uses KEAPI library to perform the operation and sends result back to the client.

Fig.1.

– Kontron EAPI Architecture

Advertising