bluerobotics / bluerobotics/ping-python
Add instructions on generating new Ping device type
- Linguagem predominante
- Python
- Estrelas
- 60
- Forks
- 39
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Descrição
There are some users interested in extending Ping-Protocol to support other devices with new messages. I just tested what it would take for a normal user to do that and here are instructions:
Copy message definitions and template from a similar device.
```
cd lib/ping-protocol/src/definitions
cp ping1d.json pinghf.json
cd ../../../../generate
cp ping1d.py.in pinghf.py.in
```
Open `generate-python.py` and add the following to the end:
```
definitionFile = "%s/pinghf.json" % definitionPath
templateFile = "%s/pinghf.py.in" % templatePath
f = open("%s/pinghf.py" % args.output_directory, "w")
f.write(g.generate(definitionFile, templateFile, {"structToken": struct_token}))
f.close()
```
Generate the new files:
```
python3 generate/generate-python.py --output-directory brping
```
Now in `python3` you can `from brping import pinghf`.
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
Direção de pesquisa
Comece com generate/generate-python.py e os arquivos de exemplo em lib/ping-protocol/src/definitions e generate; em seguida, verifique os comandos documentados para copiar ping1d.json e ping1d.py.in e executar o gerador. Concluído significa que um usuário comum pode seguir as instruções para criar arquivos pinghf e importar brping.pinghf em Python.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 62/100