robotois-light-sensor/docs/inicializacion.md

Node library for the light sensor module

# Primeros Pasos con el Sensor de Luz
El sensor de Luz es un sensor analógico, el cual proporciona una señal (voltaje) proporcional a la intensidad de luz a la que está expuesto. Este sensor debe usarse en combinación con el módulo de sensores analógicos, ya que éste proporciona el componente (**ADC**, *Analog Digital Converter*) que convierte la señal analógica del sensor en un valor numérico (*Digital*).

Lo anterior es necesario debido a que la **Raspberry PI** no cuenta con un módulo ADC. El módulo de sensores analógicos se comunica con el **Shield** usando el puerto **IIC**, por lo que no es necesario especificar el puerto al cual se conecta. Sin embargo, es importante indicar el puerto analógico al cual se conecta el sensor de Luz.

## Instalación de la Librería

La instalación de la librería se puede realizar de dos maneras:

* La primera es usando el gestor de paquetes [**npm**](https://www.npmjs.com/package/robotois-light-sensor):
```bash
npm install robotois-light-sensor
```

* La segunda opción es clonando la última versión disponible en el repositorio de [**GitHub**](https://github.com/Robotois/robotois-light-sensor):
```bash
git clone https://github.com/Robotois/robotois-light-sensor.git
```
## Conexión al Shield

El primer paso para utilizar el sensor de Luz es conectar el módulo de sensores analógicos. Como se mencionó anteriormente, para este módulo no se requiere especificar el puerto al cual se conecta, ya que utiliza el puerto **IIC**:

![Módulo de Conectores Analógicos](Analog-module-and-Shield.png)

Posteriormente se conecta el sensor de Luz al módulo de sensores analógicos. En donde es importante especificar al puerto al cual éste se va a conectar. No obstante, la plataforma Robotois cuenta con la validación requerida para especificar la conexión, pero al utilizar la librería de manera aislada es necesario especificar la conexión manualmente. En la siguiente imágen se muestra un ejemplo de cómo conectar el sensor de Luz:

![Sensor de Luz](light-sensor.png)

## Obtener valores
La manera mas sencilla de obtener mediciones del sensor de Luz es utilizando eventos. En esta librería se cuenta con dicho mecanismo, lo cual permite obtener mediciones de Luz en un rango de `0-10`, en donde el valor `0` implica que el sensor detecta poca o nada de luz, y el valor `10` indica que el sensor detecta su máximo de luz. También es importante considerar que las mediciones por eventos se realizan cada `500ms`.

Los eventos de mediciones se habilitan usando la siguiente función:

```javascript
light.enableEvents();
```

Un ejemplo de cómo utilizar los eventos es el siguiente:

```javascript
const LightSensor = require('robotois-light-sensor');

const light = new LightSensor(1);
light.enableEvents();

light.on('medicion', (value) => {
  console.log(`Luz medida: ${value}`);
});
```

El resultado del ejemplo anterior será similar al siguiente:

```
Luz medida: 1
Luz medida: 2
Luz medida: 4
Luz medida: 7
Luz medida: 8
Luz medida: 6
```

## La función `when()`
Esta librería cuenta con la función `when()` la cual permite realizar una acción con base en el valor actual de la luz medida en el sensor. Lo que quiere decir que es posible realizar una acción cuando la luz medida sea de un valor específico. El siguiente ejemplo muestra como utilizar esta función:

```javascript
const LightSensor = require('robotois-light-sensor');

const light = new LightSensor(1);

light.when(3, () => {
  console.log('Wow, la intensidad de luz es 3!!');
});

```