@nextrobot/driver-posijet

Biblioteca CMPP

�ndice

• Biblioteca CMPP
  • �ndice
  • Apresentacao
    • Principais caracter�sticas
    • Qualidade da biblioteca
  • Informacoes sobre versionamento
  • Como instalar
    • Configura��o do ambiente
    • Download e instala��o da Biblioteca CMPP
    • Uso da biblioteca

Apresentacao

Este modulo funciona como uma camada de abstra��o para controle de dispositivos CMPPs e compat�veis. O design desta biblioteca visa permitir um alto grau de abstra��o dos detalhes do controle permitindo o programador concentrar-se em aspectos de mais alto n�vel. Por�m fun��es de baixo n�vel tamb�m podem ser acessadas.

Principais caracter�sticas

• Transacoes ass�ncronas de pacotes
• Facilidade de se configurar mapas de mem�riaCMPP
• Cache de memoria CMPP para evitar comunica��o desnecessaria (configuravel)
• Simula��o de porta serial (permite emula��o dispositivos CMPP)

Qualidade da biblioteca

• Todos os modulos da biblioteca incluem testes unit�rios, inclusive com simula��o de pacotes defeituosos.
• Utiliza��o de TDD - Test Driven Development

Informacoes sobre versionamento

Esta sendo usado o workflow especial do git chamado git flow. Este mecanismo de versionamento representa o repositorio em 2 ramos principais:

1. Master: Contem as versao oficiais de lan�amento da biblioteca (versao est�vel)
2. Development: Que contem as versoes em desenvolvimento da proxima vers�o oficial da biblioteca (ou seja, pode conter alguma caracter�stica menos estavel).

Em totos estes ramos (branch) os commits s� devem ser feitos caso todos os testes unit�rios da biblioteca estejam passando.

Este workflow tamb�m conta com outros ramos (branches) que podem ser melhor consultados em sua documenta��o. Uma vis�o rapida sobre o uso da ferramenta git flow pode ser visto aqui

Como instalar

NOTA: as instrucoes abaixo foram escritas de memoria. Caso voce execute as etapas abaixo podera editar este arquivo para adicionar informacoes que considere relevante e assim auxilar as proximas pessoas que forem seguir as instru��es

O processo de instala��o e uso da biblioteca consiste em tres etapas principais: 1. Configura��o do ambiente de desenvolvimento, 2. Download da biblioteca e instala��o, 3. Uso da biblioteca

Configura��o do ambiente

NOTA: Futuramente um script poder� ser criado para realizar automaticamente os passos abaixo.

Caso seu ambiente ja esteja configurado, ou seja, se voce ja executou esta etapa ao menos uma vez em seu computador voce pode pular os passos abaixos e ir direto para a proxima etapa.

Abaixo os passos necessarias para configurar o ambiente de desenvolvimento na sua maquina.

O ambiente de desenvolvimento pode ser instalados em sistemas operacioanais Linux ou Windows. Os passos abaixo assume que a instala��o ser� feita em sistema Windows, exceto caso informado ao contrario.

1. Atualizar Windows PowerShell

   a. Va no menu iniciar e digite powershell e pressione enter para abrir a linha de comando.

   b. Digite o comando:

   $PSVersionTable.PSVersion
   

   *Caso a sua versao seja inferior a 5.1 (Major/Minor) realize a atualiza��o do seu powershell *

2. Instalar Node.Js, Typescript e Jest:

   a. Instalar o node.js

   b. Instalar TypeScript

   A forma mais simples de instalar o typescript � via gerenciador de pacotes do node.js, o npm. Digite:

   npm install -g typescript
   

   Este comando instalara o typescript globalmente na sua maquina

   c. Instalar Jest

   npm install --save-dev jest
   

3. Instalar git

4. Instalar VSCode

   a. Apos fazer download e instala��o do VSCode, instale as seguintes extens�es:

   NOTA: Estas extensoes adicionam capacidade ao VSCode de trabalhar com o git, typescript, node.js, etc. O jeito mais pratico � instalalas de dentro do VSCode no menu Viewop��o extensions

   
   - TSLint
   - npm
   - npm Intellisense
   - GitLens -- Git supercharged
   - gitignore
   - gitflow
   - Git History
   - ESLint
   - Auto Import
   
   

Download e instala��o da Biblioteca CMPP

A Biblioteca CMPP deve ser baixada para ser usada com um programa que voce esteja criando e que tenha necessidade de se comunicar com um dispositivo CMPP.

As instrucoes abaixo o auxiliam a criar um pequeno projeto que simula o envio das iniciais da frase "Hello World" para um dispositivo CMPP, usando a Biblioteca CMPP

1. Configura��o do projeto:

   a. Crie um diretorio que conter� o seu projeto Hello Word, d� a ele o nome que preferir, chamaremos este diretorio para a finalidade deste documento genericamente de $Projeto.

   b. Dentro da pasta $Projeto crie o diretorio src\.

   c. inicie o repositorio digitando node init dentro do diretorio $Projeto. Ao termin desta etapa voce dever� ter dentro do diretorio $Projeto o arquivo package.json.

2. Escreva um simples program hello world:

   a. crie na pasta $Projeto\src o arquivo helloword.ts contendo:

   import { transactSync, pacoteDeTransmissao, Direcao, } from '*CMPP*'
   
   const direcao = Direcao.ENVIO
   const canal = 1
   const comando = 0x60
   const dado = 22344 // representa a uniao dos caracteres 'H' e 'W' iniciais da frase 'Hello World!'
   const p = await pacoteDeTransmissao(direcao, canal, comando, dado)
   console.log(p)
   

   b. Na tentativa de executar este programa voce devera obter uma mensagem de erro pois a bilioteca CMPP nao foi instalada ainda. Estando dentro do diretorio $Projeto\src, digite:

   tsc helloword.ts
   

3. Instalando a Biblioteca CMPP

   a. Crie um diretorio chamdo lib dentro da pasta $Projeto. Dentro deste novo diretorio digite:

   git clone https://github.com/fvilante/posijet1/tree/master
   

   Este comando fara o acesso a internet e a busca da biblioteca

   b. Mude para o novo diretorio que foi criado contendo o codigo fonte da biblioteca. e digite:

   npm test
   

   Este comando devera rodar os testes unitarios em cima do codigo fonte da biblioteca. Caso a instala��o esteja em perfeito funcionamento todos os testes deverao passar.

   c. Instale as dependencias da biblioteca, digite:

   npm install
   

   Este comando instalar automaticamente todas as bibliotecas da qual a Biblioteca CMPP depende para funcionar

Uso da biblioteca

Se voce chegou at� esta etapa, voce ja esta com o seu ambiente configurado, tem um projeto HelloWord configurado que usa a Biblioteca CMPP para enviar as iniciais da frase "Hello Word" para o dispositivo CMPP.

Para rodar o seu programa voce deve mudar para o diretorio $PROJETO e digitar:

tsc /src/helloworld.ts