jsapi.h File Reference

This header file defines the ImageCraft JumpStart Application Programming Interface (JSAPI) for the Cortex STM32F0xx family of MCUs. Copyright 2017-2018 ImageCraft Creations Inc. All Rights Reserved. You may only use JumpStart API (JSAPI) in your code if you have purchased a license for JumpStart C++ for Cortex. More...

#include "jsapi/Cortex-Generic/jsapi_common.h"
#include "jsapi/Common-ST/jsapi_st_mcu.h"
#include "jsapi/Common-ST/jsapi_i2c_wire_F0XX_F3XX_F7XX.h"

Go to the source code of this file.

Classes
struct	JSAPI_ClocksTypeDef
	The current frequencies of various clocks. More...
class	JSAPI_ADC
	ADC abstraction. Use the hardware ADC object. You must have called JSAPI_GPIO::MakeAnalog() function to setup the ADC pin prior to using the ADC functions. More...
class	JSAPI_CLOCK
	MCU clock system. More...

Macros
#define	JSAPI_F0XX   1

Enumerations
enum	OSPEED { OSPEED_LOW = 0, OSPEED_MED = 1, OSPEED_HIGH = 0x3, OSPEED_HIGHEST = OSPEED_HIGH }
	Output pin speed. The values correpond to the hardware encoding. More...
enum	CLOCK_SRC {   CLK_HSI, CLK_HSE, CLK_PLL, CLK_HSI48,   CLK_HSEBYP }
	Clock source. More...
enum	MCO_SOURCE {   MCO_NONE, MCO_HSI14, MCO_LSI, MCO_LSE,   MCO_SYSCLK, MCO_HSI, MCO_HSE, MCO_PLL,   MCO_HSI48 }
	Master Clock Output (MCO), input source. These are the values from RCC_CFGR_MCO.

Variables
JSAPI_ADC	adc1
	Hardware ADC units. NOTE: not all MCU devices have all these units. Please refer to the devoce data sheet. Accessing nonexistent device will cause problems.
JSAPI_CLOCK	jsapi_clock
	JSAPI_CLOCK instance.
JSAPI_CORTEX_CORE	jsapi_cortex_core
	JSAPI_CORTEX_CORE instance.
JSAPI_EXTI	exti0
	Hardware EXTI units. NOTE: not all MCU devices have all these units. Please refer to the devoce data sheet. Accessing nonexistent device will cause problems.
JSAPI_EXTI	exti1
JSAPI_EXTI	exti2
JSAPI_EXTI	exti3
JSAPI_EXTI	exti4
JSAPI_EXTI	exti5
JSAPI_EXTI	exti6
JSAPI_EXTI	exti7
JSAPI_EXTI	exti8
JSAPI_EXTI	exti9
JSAPI_EXTI	exti10
JSAPI_EXTI	exti11
JSAPI_EXTI	exti12
JSAPI_EXTI	exti13
JSAPI_EXTI	exti14
JSAPI_EXTI	exti15
JSAPI_GPIO	porta
	Hardware GPIO units. NOTE: not all MCU devices have all these units. Please refer to the devoce data sheet. Accessing nonexistent device will cause problems.
JSAPI_GPIO	portb
JSAPI_GPIO	portc
JSAPI_GPIO	portd
JSAPI_GPIO	porte
JSAPI_GPIO	portf
JSAPI_I2C_WIRE	i2c1
	Hardware I2C(_WIRE) units. NOTE: not all MCU devices have all these units. Please refer to the devoce data sheet. Accessing nonexistent device will cause problems.
JSAPI_I2C_WIRE	i2c2
JSAPI_SPI	spi1
	Hardware SPI units. NOTE: not all MCU devices have all these units. Please refer to the devoce data sheet. Accessing nonexistent device will cause problems.
JSAPI_SPI	spi2
JSAPI_ST_MCU	jsapi_st_mcu
	JSAPI_ST_MCU instance.
JSAPI_USART	usart1
	Hardware USART units. NOTE: not all MCU devices have all these units. Please refer to the devoce data sheet. Accessing nonexistent device will cause problems.
JSAPI_USART	usart2
JSAPI_USART	usart3
JSAPI_USART	usart4
JSAPI_USART	usart5
JSAPI_USART	usart6
JSAPI_USART	usart7
JSAPI_USART	usart8
JSAPI_TIMER	timer1
	Hardware TIMER units. NOTE: not all MCU devices have all these units. Please refer to the devoce data sheet. Accessing nonexistent device will cause problems.
JSAPI_TIMER	timer2
JSAPI_TIMER	timer3
JSAPI_TIMER	timer6
JSAPI_TIMER	timer7
JSAPI_TIMER	timer14
JSAPI_TIMER	timer15
JSAPI_TIMER	timer16
JSAPI_TIMER	timer17

Detailed Description

This header file defines the ImageCraft JumpStart Application Programming Interface (JSAPI) for the Cortex STM32F0xx family of MCUs. Copyright 2017-2018 ImageCraft Creations Inc. All Rights Reserved. You may only use JumpStart API (JSAPI) in your code if you have purchased a license for JumpStart C++ for Cortex.

"C:\iccv9cortex\include\jsapi\ST\STM32F0\jsapi.h" This file is commented using Doxygen. To see the generated Help page on the web, see link on this page http://imagecraft.com/documentation/jumpstart-c-documentation

Enumeration Type Documentation

enum CLOCK_SRC

Clock source.

Enumerator
CLK_HSI	Internal clock
CLK_HSE	External clock
CLK_PLL	PLL
CLK_HSI48	HSI48, existed only in some F0xx members
CLK_HSEBYP	External clock with BYPASS

enum OSPEED

Output pin speed. The values correpond to the hardware encoding.

Enumerator
OSPEED_LOW	2 MHz
OSPEED_MED	10 MHz
OSPEED_HIGH	50 MHz
OSPEED_HIGHEST	alias for the highest speed