https://github.com/karurochori/ebyte-lora-ts
Portable library to configure ebyte lora devices using typescript/javascript
https://github.com/karurochori/ebyte-lora-ts
ebyte-e22 lora serial typescript
Last synced: about 1 year ago
JSON representation
Portable library to configure ebyte lora devices using typescript/javascript
- Host: GitHub
- URL: https://github.com/karurochori/ebyte-lora-ts
- Owner: KaruroChori
- License: bsd-3-clause
- Created: 2024-09-05T20:55:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-07T12:04:51.000Z (over 1 year ago)
- Last Synced: 2025-01-13T09:36:25.647Z (over 1 year ago)
- Topics: ebyte-e22, lora, serial, typescript
- Language: TypeScript
- Homepage:
- Size: 45.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ebyte-lora-ts
> [!CAUTION]
> Very much WIP and not documented. For reference, the [official documentation](https://www.cdebyte.com/products/E22-900T22U).
> So far only the `ebyte e22-900t22u` is supported, but other models can be easily added with minimal changes.
> It has been tested on hardware, but coverage is not full.
This library provides some utility framework to configure and operate lora devices from **ebyte** via typescript.
The design goal of this library is to be platform-agnostic, so you might use it write a [webapp](https://developer.mozilla.org/en-US/docs/Web/API/SerialPort) or some portable CLI tool to replace the official one which is only available for windows.
This library is only handling the packet building & validation from/to json config files, you will have to provide `read` and `write` functions to support your serial device.
## Compatibility
- Node via `@serialport/bindings-cpp`, targetting most operating systems and architectures.
- Bun at the moment is not compatible with that node library, and I was not able to find any alternative for now.
- [QuickJS](https://github.com/quickjs-ng/quickjs) should work fine as long as you bring your own read/write.
- [Txiki](https://github.com/saghul/txiki.js) as well. I wrote a [serial module](https://github.com/KaruroChori/serial-txiki-module) a while back, this is expected to work.
## How to use
TBW
## Information for developers
If you want to contribute to this project, or you need more details about the implementation, I wrote some notes [here](./docs/developers.md).
## Milestones
You can find information about what is expected in future releases [here](./TODO.md).
Please, keep in mind those plans are subject to change at any point in time.