VL53L1

Esse repositório contém uma biblioteca para lidar com o sensor de distância VL53L1 da ST.

Essa biblioteca foi feita para ser utilizada como submódulo no STM32ProjectTemplate.

Índice

• Índice
• Quick Start
  • Adicionando o Submódulo ao Projeto
  • Guia de Utilização
    • Instruções Básicas
    • Configurações Adicionais
    • Exemplo de Adaptação da Biblioteca
• Guia de Funcionamento
  • Estruturas
  • Inicialização
• To Do

Quick Start

O objetivo desta seção é proporcionar todas as informações essenciais para utilizar o VL53L1x de maneira rápida. Um guia mais completo das fucionalidades da biblioteca pode ser encontrado em Guia de Funcionamento.

Adicionando o Submódulo ao Projeto

Crie um diretório chamado lib, caso não exista:

mkdir lib

E adicione o submódulo fazendo:

• Com HTTPS:

git submodule add --name VL53L1 https://github.com/ThundeRatz/VL53L1.git lib/VL53L1

• Com SSH:

git submodule add --name VL53L1 [email protected]:ThundeRatz/VL53L1.git lib/VL53L1

Guia de Utilização

Instruções Básicas

Para utilizar a biblioteca, é necessário que, para cada sensor utlizado, sejam criadas as seguintes variáveis.

VL53L1_Dev_t device;
VL53L1_RangingMeasurementData_t ranging_data;
VL53L1_CalibrationData_t calibration;

Algumas configurações podem ser atribuídas automaticamente à variável VL53L1_Dev_t device pela função vl53l1_set_default_config(VL53L1_Dev_t* p_device). Outras, como informações específicas do I2C e do pino XSHUT, devem ser atribuídas manualmente pelo usuário antes da inicialização.

Cada sensor deve ser inicializado separadamente com a função:

VL53L1_Error vl53l1_init(VL53L1_Dev_t* p_device, VL53L1_CalibrationData_t* calibration);

Quando utilizar mais de um sensor na mesma aplicação, é necessário desligar todos incialmente, e, individualmente, ligar, trocar o endereço de I2C e reiniciar cada um. Esse processo é feito com as funções abaixo, seguidas pela função de init.

void vl53l1_turn_off(VL53L1_Dev_t* p_device);

void vl53l1_turn_on(VL53L1_Dev_t* p_device);

VL53L1_API VL53L1_Error VL53L1_SetDeviceAddress(VL53L1_DEV Dev, uint8_t DeviceAddress);

É importante que o usuário verifique o valor retornado por todas as funções acima. Valores diferentes de 0 indicam má inicialização de algum sensor, o que compromete a incialização dos subsequentes e pode causar um comportamento estranho em todas as leituras.

E finalmente, para atualizar a leitura do sensor, utiliza-se a função:

uint8_t vl53l1_update_reading(VL53L1_Dev_t* p_device, VL53L1_RangingMeasurementData_t* p_ranging_data, uint16_t* p_reading,
                             uint16_t max_range);

Onde uint16_t* p_reading armazena o valor da leitura.

Configurações Adicionais

Caso conveniente, o usuário pode configurar algumas propriedades opcionais dos sensores, como o Modo de Distância e a Expensa de Tempo. Essas configurações podem ser configuradas automaticamente pela função vl53l1_set_default_config(VL53L1_Dev_t* p_device), ou manualmente pelo usuário como uma atribuição à estrutura VL53L1_Dev_t device. Explicações mais detalhadas desses atributos estão presentes a seguir:

Modo de Distância

O Modo de Distância configura propriedades internas do dispositivo dependendo do alcance desejado pelo usuário. Ele pode ser atribuído os seguintes valores:

• VL53L1_DISTANCEMODE_SHORT - Até 1.3 m
• VL53L1_DISTANCEMODE_MEDIUM - Até 3 m
• VL53L1_DISTANCEMODE_LONG - Até 4 m (Padrão)

Por exemplo, caso o uso idealizado do sensor demande um alcance de 2 m, a atribuição do Modo de Distância poderia ser feita da seguinte forma:

device.distance_mode = VL53L1_DISTANCEMODE_MEDIUM;

Expensa de Tempo

A Expensa de Tempo é o tempo que o sensor gastará para realizar uma medida de distância. Quanto maior a Expensa de Tempo, maior o alcance e a precisão da medida, às custas de um atraso maior na taxa de atualização. O usuário pode configurar o valor desse intervalo de tempo de 20 ms a 1000 ms. Por padrão, ele é inicializado como 50 ms.

Caso seja desejada uma Expensa de Tempo de 65 ms, a configuração seria a seguinte:

device.timing_budget_us = 65000; // Medida em microssegundos

Exemplo de adaptação da biblioteca para 3 sensores VL53L1.

Um projeto exemplo pode ser encontrado em Berbardo/VL53L1_Example, feito com base no STM32ProjectTemplate.

Guia de Funcionamento

Essa biblioteca utiliza a API completa do VL53L1 para adaptá-lo, uma interface complexa que possibilita a personalização de diversas configurações dos sensores. Esta seção objetiva familiarizar o usuário à biblioteca para entender seus usos e possibilitar sua modificação.

Estruturas

Para a utilização do VL53L1x, é necessário instanciar variáveis de três estruturas diferentes para cada um. Como a configuração e o monitoramento dos sensores é feita majoritariamente por meio dessas variáveis, a parte a seguir explica cada uma dessas estruturas para facilitar seu controle.

• VL53L1_Dev_t

• VL53L1_RangingMeasurementData_t

• VL53L1_CalibrationData_t

Inicialização

O primeiro passo para a utilização do sensor é sua inicialização, que se dá por meio da função vl53l1_init. Essa função inicializa, calibra, configura e começa a medir as leituras de distância. A explicação de cada uma dessas ações será apresentada a seguir:

To Do

To Do

• Documentar:
  • Guia de Funcionamento
    • Estruturas
    • Inicialização
      • Limit Checks
    • Utilização de mais de um sensor
    • Atualização da Leitura (e erros)
• Programar:
  • Escolha dos Limit Checks
  • Region of Interest (RoI)

---

Equipe ThundeRatz de Robótica