unit.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Linaro
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZSL_MEASUREMENT_UNIT_H__
#define ZSL_MEASUREMENT_UNIT_H__
 
#include <zsl/zsl.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum zsl_mes_unit_ctype {
    ZSL_MES_UNIT_CTYPE_UNDEFINED                    = 0x00,
 
    /* 0x10..0x4F: Standard C types. */
    ZSL_MES_UNIT_CTYPE_IEEE754_FLOAT32              = 0x10,
    ZSL_MES_UNIT_CTYPE_IEEE754_FLOAT64              = 0x11,
    ZSL_MES_UNIT_CTYPE_IEEE754_FLOAT128             = 0x12,
    ZSL_MES_UNIT_CTYPE_S8                           = 0x13,
    ZSL_MES_UNIT_CTYPE_S16                          = 0x14,
    ZSL_MES_UNIT_CTYPE_S32                          = 0x15,
    ZSL_MES_UNIT_CTYPE_S64                          = 0x16,
    ZSL_MES_UNIT_CTYPE_S128                         = 0x17,
    ZSL_MES_UNIT_CTYPE_U8                           = 0x18,
    ZSL_MES_UNIT_CTYPE_U16                          = 0x19,
    ZSL_MES_UNIT_CTYPE_U32                          = 0x1A,
    ZSL_MES_UNIT_CTYPE_U64                          = 0x1B,
    ZSL_MES_UNIT_CTYPE_U128                         = 0x1C,
    ZSL_MES_UNIT_CTYPE_BOOL                         = 0x1D,
    ZSL_MES_UNIT_CTYPE_COMPLEX_32                   = 0x30,
    ZSL_MES_UNIT_CTYPE_COMPLEX_64                   = 0x31,
 
    /* 0x80..0x8F: Range types (unit interval, percent, etc.) */
    ZSL_MES_UNIT_CTYPE_RANG_UNIT_INTERVAL_32        = 0x80,
    ZSL_MES_UNIT_CTYPE_RANG_UNIT_INTERVAL_64        = 0x81,
    ZSL_MES_UNIT_CTYPE_RANG_PERCENT_32              = 0x82,
    ZSL_MES_UNIT_CTYPE_RANG_PERCENT_64              = 0x83,
 
    /* 0xF0..0xFE: User-defined types. */
    ZSL_MES_UNIT_CTYPE_USER_1                       = 0xF0,
    ZSL_MES_UNIT_CTYPE_USER_2                       = 0xF1,
    ZSL_MES_UNIT_CTYPE_USER_3                       = 0xF2,
    ZSL_MES_UNIT_CTYPE_USER_4                       = 0xF3,
    ZSL_MES_UNIT_CTYPE_USER_5                       = 0xF4,
    ZSL_MES_UNIT_CTYPE_USER_6                       = 0xF5,
    ZSL_MES_UNIT_CTYPE_USER_7                       = 0xF6,
    ZSL_MES_UNIT_CTYPE_USER_8                       = 0xF7,
    ZSL_MES_UNIT_CTYPE_USER_9                       = 0xF8,
    ZSL_MES_UNIT_CTYPE_USER_10                      = 0xF9,
    ZSL_MES_UNIT_CTYPE_USER_11                      = 0xFA,
    ZSL_MES_UNIT_CTYPE_USER_12                      = 0xFB,
    ZSL_MES_UNIT_CTYPE_USER_13                      = 0xFC,
    ZSL_MES_UNIT_CTYPE_USER_14                      = 0xFD,
    ZSL_MES_UNIT_CTYPE_USER_15                      = 0xFE,
 
    ZSL_MES_UNIT_CTYPE_MAX                          = 0xFF
};
 
enum zsl_mes_unit_si {
    ZSL_MES_UNIT_SI_UNDEFINED               = 0,
 
    /* 0x0010..0x001F (16-31): SI Base Units. */
    ZSL_MES_UNIT_SI_AMPERE                  = 0x10,
    ZSL_MES_UNIT_SI_CANDELA                 = 0x11,
    ZSL_MES_UNIT_SI_KELVIN                  = 0x12,
    ZSL_MES_UNIT_SI_KILOGRAM                = 0x13,
    ZSL_MES_UNIT_SI_METER                   = 0x14,
    ZSL_MES_UNIT_SI_MOLE                    = 0x15,
    ZSL_MES_UNIT_SI_SECOND                  = 0x16,
 
    /* 0x0020..0x003F (32-63): SI Derived Units. */
    ZSL_MES_UNIT_SI_BECQUEREL               = 0x20,
    ZSL_MES_UNIT_SI_COULOMB                 = 0x21,
    ZSL_MES_UNIT_SI_DEGREE_CELSIUS          = 0x22,
    ZSL_MES_UNIT_SI_FARAD                   = 0x23,
    ZSL_MES_UNIT_SI_GRAY                    = 0x24,
    ZSL_MES_UNIT_SI_HENRY                   = 0x25,
    ZSL_MES_UNIT_SI_HERTZ                   = 0x26,
    ZSL_MES_UNIT_SI_JOULE                   = 0x27,
    ZSL_MES_UNIT_SI_KATAL                   = 0x28,
    ZSL_MES_UNIT_SI_LUMEN                   = 0x29,
    ZSL_MES_UNIT_SI_LUX                     = 0x2A,
    ZSL_MES_UNIT_SI_NEWTON                  = 0x2B,
    ZSL_MES_UNIT_SI_OHM                     = 0x2C,
    ZSL_MES_UNIT_SI_PASCAL                  = 0x2D,
    ZSL_MES_UNIT_SI_RADIAN                  = 0x2E,
    ZSL_MES_UNIT_SI_SIEMENS                 = 0x2F,
    ZSL_MES_UNIT_SI_SIEVERT                 = 0x30,
    ZSL_MES_UNIT_SI_STERADIAN               = 0x31,
    ZSL_MES_UNIT_SI_TESLA                   = 0x32,
    ZSL_MES_UNIT_SI_VOLT                    = 0x33,
    ZSL_MES_UNIT_SI_WATT                    = 0x34,
    ZSL_MES_UNIT_SI_WEBER                   = 0x35,
 
    /* 0x0080..0x008F (128-143): 'Unitless' Units. */
    ZSL_MES_UNIT_SI_PERCENT                 = 0x80,
    ZSL_MES_UNIT_SI_INTERVAL                = 0x81,
 
    /* 0x1000..0x10FF: ZSL_DT_BASE_AREA Combined Units. */
    ZSL_MES_UNIT_SI_METERS_2                = 0x1000,
 
    /* 0x1100..0x11FF: ZSL_DT_BASE_ACCELERATION Combined Units. */
    ZSL_MES_UNIT_SI_METER_PER_SECOND_2      = 0x1100,
 
    /* 0x1200..0x12FF: ZSL_DT_BASE_AMPLITUDE Combined Units. */
 
    /* 0x1300..0x13FF: ZSL_DT_BASE_CAPACITANCE Combined Units. */
 
    /* 0x1400..0x14FF: ZSL_DT_BASE_COLOR Combined Units. */
 
    /* 0x1500..0x15FF: ZSL_DT_BASE_COORDINATES Combined Units. */
 
    /* 0x1600..0x16FF: ZSL_DT_BASE_CURRENT Combined Units. */
 
    /* 0x1700..0x17FF: ZSL_DT_BASE_DIMENSION Combined Units. */
 
    /* 0x1800..0x18FF: ZSL_DT_BASE_FREQUENCYY Combined Units. */
 
    /* 0x1900..0x19FF: ZSL_DT_BASE_HUMIDITY Combined Units. */
    ZSL_MES_UNIT_SI_RELATIVE_HUMIDITY = 0x1900,
 
    /* 0x1A00..0x1AFF: ZSL_DT_BASE_INDUCTANCE Combined Units. */
 
    /* 0x1B00..0x1BFF: ZSL_DT_BASE_LIGHT Combined Units. */
    ZSL_MES_UNIT_SI_CANDELA_PER_METER_2                     = 0x1B00,
    ZSL_MES_UNIT_SI_JOULE_PER_METER_2                       = 0x1B01,
    ZSL_MES_UNIT_SI_JOULE_PER_METER_2_PER_HZ                = 0x1B02,
    ZSL_MES_UNIT_SI_JOULE_PER_METER_2_PER_NM                = 0x1B03,
    ZSL_MES_UNIT_SI_JOULE_PER_METER_3                       = 0x1B04,
    ZSL_MES_UNIT_SI_LUMEN_PER_METER_2                       = 0x1B05,
    ZSL_MES_UNIT_SI_LUMEN_PER_WATT                          = 0x1B06,
    ZSL_MES_UNIT_SI_LUMEN_SECOND                            = 0x1B07,
    ZSL_MES_UNIT_SI_LUMEN_SECOND_PER_METER_3                = 0x1B08,
    ZSL_MES_UNIT_SI_LUX_SECOND                              = 0x1B09,
    ZSL_MES_UNIT_SI_WATTS_PER_HERTZ                         = 0x1B0A,
    ZSL_MES_UNIT_SI_WATTS_PER_METER_2                       = 0x1B0B,
    ZSL_MES_UNIT_SI_WATTS_PER_METER_2_PER_HZ                = 0x1B0C,
    ZSL_MES_UNIT_SI_WATTS_PER_METER_2_PER_NM                = 0x1B0D,
    ZSL_MES_UNIT_SI_WATTS_PER_NM                            = 0x1B0E,
    ZSL_MES_UNIT_SI_WATTS_PER_STERADIAN                     = 0x1B0F,
    ZSL_MES_UNIT_SI_WATTS_PER_STERADIAN_PER_HERTZ           = 0x1B10,
    ZSL_MES_UNIT_SI_WATTS_PER_STERADIAN_PER_METER_2         = 0x1B11,
    ZSL_MES_UNIT_SI_WATTS_PER_STERADIAN_PER_METER_2_PER_HZ  = 0x1B12,
    ZSL_MES_UNIT_SI_WATTS_PER_STERADIAN_PER_METER_2_PER_NM  = 0x1B13,
    ZSL_MES_UNIT_SI_WATTS_PER_STERADIAN_PER_NM              = 0x1B14,
 
    /* 0x1C00..0x1CFF: ZSL_DT_BASE_MAGNETIC_FIELD Combined Units. */
    ZSL_MES_UNIT_SI_MICROTESLA                              = 0x1C00,
 
    /* 0x1D00..0x1DFF: ZSL_DT_BASE_MASS Combined Units. */
    ZSL_MES_UNIT_SI_GRAMS                                   = 0x1D00,
 
    /* 0x1E00..0x1EFF: ZSL_DT_BASE_MOMENTUM Combined Units. */
 
    /* 0x1F00..0x1FFF: ZSL_DT_BASE_ORIENTATION Combined Units. */
 
    /* 0x2000..0x20FF: ZSL_DT_BASE_PHASE Combined Units. */
 
    /* 0x2100..0x21FF: ZSL_DT_BASE_PRESSURE Combined Units. */
    ZSL_MES_UNIT_SI_HECTOPASCAL = 0x2100,
 
    /* 0x2200..0x22FF: ZSL_DT_BASE_RESISTANCE Combined Units. */
 
    /* 0x2300..0x23FF: ZSL_DT_BASE_SOUND Combined Units. */
 
    /* 0x2400..0x24FF: ZSL_DT_BASE_TEMPERATURE Combined Units. */
 
    /* 0x2500..0x25FF: ZSL_DT_BASE_TIME Combined Units. */
 
    /* 0x2600..0x26FF: ZSL_DT_BASE_VELOCITY Combined Units. */
    ZSL_MES_UNIT_SI_METERS_3_SECOND         = 0x2601,
 
    /* 0x2700..0x27FF: ZSL_DT_BASE_VOLTAGE Combined Units. */
    ZSL_MES_UNIT_SI_MILLIVOLTS              = 0x2700,
 
    /* 0x2800..0x28FF: ZSL_DT_BASE_VOLUME Combined Units. */
    ZSL_MES_UNIT_SI_METERS_3                = 0x2800,
 
    /* 0x2900..0x29FF: ZSL_DT_BASE_ACIDITY Combined Units. */
    ZSL_MES_UNIT_SI_PH                      = 0x2900,
 
    /* 0x2A00..0x2AFF: ZSL_DT_BASE_CONDUCTIVITY Combined Units. */
    ZSL_MES_UNIT_SI_SIEMENS_PER_METER       = 0x2A00,
 
    /* 0x2B00..0x2BFF: ZSL_DT_BASE_FORCE Combined Units. */
 
    /* 0x2C00..0x2CFF: ZSL_DT_BASE_ENERGY Combined Units. */
 
    /* 0xFF00..0xFFFE = User defined units. */
    ZSL_MES_UNIT_SI_USER_DEFINED_1          = 0xFF00,
    ZSL_MES_UNIT_SI_USER_DEFINED_255        = 0xFFFE,
 
    ZSL_MES_UNIT_SI_MAX                     = 0xFFFF
};
 
enum zsl_mes_si_scale {
    ZSL_MES_SI_SCALE_YOTTA  = 24,                   
    ZSL_MES_SI_SCALE_ZETTA  = 21,                   
    ZSL_MES_SI_SCALE_EXA    = 18,                   
    ZSL_MES_SI_SCALE_PETA   = 15,                   
    ZSL_MES_SI_SCALE_TERA   = 12,                   
    ZSL_MES_SI_SCALE_GIGA   = 9,                    
    ZSL_MES_SI_SCALE_MEGA   = 6,                    
    ZSL_MES_SI_SCALE_KILO   = 3,                    
    ZSL_MES_SI_SCALE_HECTO  = 2,                    
    ZSL_MES_SI_SCALE_DECA   = 1,                    
    ZSL_MES_SI_SCALE_NONE   = 0,                    
    ZSL_MES_SI_SCALE_DECI   = -1,                   
    ZSL_MES_SI_SCALE_CENTI  = -2,                   
    ZSL_MES_SI_SCALE_MILLI  = -3,                   
    ZSL_MES_SI_SCALE_MICRO  = -6,                   
    ZSL_MES_SI_SCALE_NANO   = -9,                   
    ZSL_MES_SI_SCALE_PICO   = -12,                  
    ZSL_MES_SI_SCALE_FEMTO  = -15,                  
    ZSL_MES_SI_SCALE_ATTO   = -18,                  
    ZSL_MES_SI_SCALE_ZEPTO  = -21,                  
    ZSL_MES_SI_SCALE_YOCTO  = -24,                  
};
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZSL_MEASUREMENT_UNIT_H__ */