// @file sns_ultra_violet.proto
//
// Defines the API for Ultra Violet (UV) Sensors.
// All UV Sensor drivers are required to comply with this API.
// Any new functionality for UV Sensor can be defined in a
// device specific API file.
//
// Copyright (c) 2016-2017 Qualcomm Technologies, Inc.
// All Rights Reserved.
// Confidential and Proprietary - Qualcomm Technologies, Inc.

syntax = "proto2";
import "nanopb.proto";
import "sns_std_sensor.proto";
import "sns_physical_sensor_test.proto";
import "sns_cal.proto";

// Attribute requirements:
// The UV Sensor publishes:
// 1. SNS_STD_SENSOR_ATTRID_TYPE attribute value as "ultra_violet".
// 2. SNS_STD_SENSOR_ATTRID_RESOLUTIONS attribute value in degrees mW/cm2/LSB.
// 3. SNS_STD_SENSOR_ATTRID_RANGES attribute values in degrees mW/cm2 unit.
// 4. See sns_std_sensor.proto for other attributes.

// Handling stream requests:
// 1. The UV Sensor handles the sns_std_sensor_config
//    message request for all stream enable/update requests.

// Handling stream events:
// 1. The UV Sensor publishes UV data in ambient light using the
//    sns_std_sensor_event message.
// 2. Each stream event contains following factory calibrated data fields:
//    data[0] = Bit mask to determine which outputs are supported:
//              bit[0]: 1 if UV-A is supported else 0
//              bit[1]: 1 if UV-B is supported else 0
//              bit[2]: 1 if Total UV is supported else 0
//              bit[3]: 1 if UV index is supported else 0
//              all other bits are 0
//    data[1] = UV-A radiation in mW/cm2
//    data[2] = UV-B radiation in mW/cm2
//    data[3] = Total UV radiation in mW/cm2
//    data[4] = Unitless UV index number
// 3. Each stream event publishes an accuracy field:
//    SNS_STD_SENSOR_SAMPLE_STATUS_UNRELIABLE to mark invalid samples when hardware is
//    yet to stabilize after the sensor is configured.
//    SNS_STD_SENSOR_SAMPLE_STATUS_ACCURACY_HIGH to mark samples when they are valid.
// 4. The UV Sensor publishes a configuration event using the
//    sns_std_sensor_physical_config_event message.
//    It publishes this event each time there is change in hardware config of the sensor
//    and contains current physical sensor config of the sensor.
// 5. The UV Sensor publishes a factory calibration event using the
//    sns_cal_event message. It uses bias and scale_factor fields in this event.
//    It publishes this event each time there is change in it's factory calibration
//    data or when a client sends a new streaming request.

// Handling self-test requests:
// 1. The UV Sensor implements SNS_PHYSICAL_SENSOR_TEST_TYPE_COM test
//    type using the physical sensor test API.
// 2. The UV Sensor implements SNS_PHYSICAL_SENSOR_TEST_TYPE_FACTORY test
//    type to determine factory calibration parameters using the physical
//    sensor test API. The factory test for UV Sensor calibrates
//    the sensor such that it's output is comparable to a standard
//    UV Meter output in any lighting condition.
// 3. The UV Sensor could implement other test types.

// Handling test events:
// 1. The UV Sensor uses sns_physical_sensor_test_event message to publish
//    a test completion event.
// 2. The test_passed field in sns_physical_sensor_test_event is used to output the
//    pass/fail result of self-test execution.
// 3. The test_data field in sns_physical_sensor_test_event could be used to output any
//    driver-specific error data.
