cos303.h File Reference

Detailed Description

This file holds definitions for the CiA 303 specification.

Include dependency graph for cos303.h:

Macros
#define	COS303_PHYSICAL_UNIT(SiPrefix, SiNumerator, SiDenominator, Profile)

Enumerations
enum	Cos303_SI_Prefix_e
enum	Cos303_SI_Unit_e

Macro Definition Documentation

COS303_PHYSICAL_UNIT

#define COS303_PHYSICAL_UNIT	(		SiPrefix,
			SiNumerator,
			SiDenominator,
			Profile
	)

Value:

                                    ((uint32_t)( \
                                    (((uint32_t)SiPrefix << 24) & 0xFF000000)     |       \
                                    (((uint32_t)SiNumerator << 16) & 0x00FF0000)  |       \
                                    (((uint32_t)SiDenominator << 8) & 0x0000FF00) |       \
                                    (((uint32_t)Profile) & 0x000000FF)                    \
                                                                            ))

Parameters

[in]	SiPrefix	value defined by Cos303_SI_Prefix_e
[in]	SiNumerator	value defined by Cos303_SI_Unit_e
[in]	SiDenominator	value defined by Cos303_SI_Unit_e
[in]	Profile	reserved, always 0

The notation indexes represent hexadecimal code values for the ISO 80000 series’ physical units and prefixes in CiA documents, especially in device, interface and application profiles. The value structure of a configuration parameter, which determines the physical unit, should contain a notation index for SI prefix and notation indexes for SI unit as SI unit numerator and denominator.

Examples

uiint32_t   ulDegreeCelsiusT = COS303_PHYSICAL_UNIT(eCOS303_SI_PREFIX_NONE, 
                                                    eCOS303_SI_UNIT_DEGREE_CELSIUS,
                                                    eCOS303_SI_UNIT_NONE,
                                                    0);
 
uiint32_t   ulMilliVoltT     = COS303_PHYSICAL_UNIT(eCOS303_SI_PREFIX_MILLI, 
                                                    eCOS303_SI_UNIT_VOLT,
                                                    eCOS303_SI_UNIT_NONE,
                                                    0);

Enumeration Type Documentation

Cos303_SI_Prefix_e

enum Cos303_SI_Prefix_e

Representation of SI prefixes

Enumerator
eCOS303_SI_PREFIX_GIGA	giga, 109, [G]
eCOS303_SI_PREFIX_MEGA	mega, 106, [M]
eCOS303_SI_PREFIX_KILO	kilo, 103, [k]
eCOS303_SI_PREFIX_NONE	no prefix, 100
eCOS303_SI_PREFIX_MILLI	milli, 10-3 [m]
eCOS303_SI_PREFIX_MICRO	micro, 10-6 [µ]
eCOS303_SI_PREFIX_NANA	nano, 10-9 [n]

Cos303_SI_Unit_e

enum Cos303_SI_Unit_e

Representation of SI units

Enumerator
eCOS303_SI_UNIT_NONE	dimensionless
eCOS303_SI_UNIT_METRE	meter [m]
eCOS303_SI_UNIT_KILOGRAM	kilogram [kg]
eCOS303_SI_UNIT_SECOND	second [s]
eCOS303_SI_UNIT_AMPERE	ampere [A]
eCOS303_SI_UNIT_KELVIN	kelvin [K]
eCOS303_SI_UNIT_MOLE	mole [mol]
eCOS303_SI_UNIT_CANDELA	candela [cd]
eCOS303_SI_UNIT_RADIAN	radian [rad]
eCOS303_SI_UNIT_STERADIN	steradian [sr]
eCOS303_SI_UNIT_HERTZ	hertz [Hz]
eCOS303_SI_UNIT_NEWTON	newton [N]
eCOS303_SI_UNIT_PASCAL	pascal [Pa]
eCOS303_SI_UNIT_JOULE	joule [J]
eCOS303_SI_UNIT_WATT	watt [W]
eCOS303_SI_UNIT_COULOMB	coulomb [C]
eCOS303_SI_UNIT_VOLT	volt [V]
eCOS303_SI_UNIT_FARAD	farad [F]
eCOS303_SI_UNIT_OHM	ohm [Ω]
eCOS303_SI_UNIT_SIEMENS	siemens [S]
eCOS303_SI_UNIT_WEBER	weber [Wb]
eCOS303_SI_UNIT_TESLA	tesla [T]
eCOS303_SI_UNIT_HENRY	henry [H]
eCOS303_SI_UNIT_DEGREE_CELSIUS	degree celsius [°C]
eCOS303_SI_UNIT_LUMEN	lumen [lm]
eCOS303_SI_UNIT_LUX	lux [lx]
eCOS303_SI_UNIT_LITRE	litre [l]
eCOS303_SI_UNIT_HOUR	hour [h]
eCOS303_SI_UNIT_DAY	day [d]
eCOS303_SI_UNIT_YEAR	year [a]
eCOS303_SI_UNIT_GRAM	gram [g]
eCOS303_SI_UNIT_TONNE	tonne [t]
eCOS303_SI_UNIT_PARSEC	parsec [pc]
eCOS303_SI_UNIT_METER_PER_SQUARE_SECOND	acceleration [m/s^2]