search

themikefuller / axez

Simple AX.25 Implementation for Packet Radio
MIT License
3 stars 0 forks source link

Typescript Support #1

Open taylorsreid opened 5 months ago

taylorsreid commented 5 months ago

Love this library that you have made. I'd like to add some TypeScript types in order to make it easier to debug my application so I was wondering if you were accepting pull requests? If so, would you prefer the JS files be converted to TS files with internal types, or to put them into a .d.ts file and leave the JS alone? I'm willing to write either of them myself.

Thanks again!

themikefuller commented 5 months ago

Good evening, Taylor

Thank you for your interest in the project. I never got around to writing documentation, and I'm surprised anyone else is actually using it. Kind of curious what you're using it for actually. Are you a HAM operator?

Do you want to just fork it? I'm not a TypeScript user, but I know it's popular. I published it under the MIT license, so you are free to copy and modify the code for pretty much any purpose.

When I got into HAM radio I wanted to do something with packet radio. Most of my projects are node.js based, and I noticed that there wasn't much going on in the JavaScript space with HAM radio. I initially planned on using it for a Peer-to-Peer chat application. I did some basic experimenting and built a proof-of-concept web application.

What does your application do?

taylorsreid commented 5 months ago

I am a ham operator actually, callsign is KO4LCM. I've been looking for a project to collaborate on to build up my portfolio a bit, and this combines two of my hobbies, programming and ham radio (especially packet). The library wasn't terribly difficult to figure out how to use just from looking at the tests file. I was very pleasantly surprised to see how easily it worked with my Mobilinkd TNC and handheld, and with my Icom 7100 (by linking a virtual COM port to forward to the UZ7HO sound modem kiss port).

I am more than happy to just fork the project, I just wanted to offer to contribute to the original first if you were still interested in the project. I have a few other ideas like adding optional compression to the message field, and adding TCP kiss port support without having to use a virtual COM port bridge. I've already managed to get compression, sending, and decompression working successfully by using Node's zlib brotli.

As of right now I'm working on an application for hams to access text based news during a disaster or when in remote areas without internet coverage. I have also considered one day building a more modern BBS possibly with Electron and all the HTML and CSS stored client side, since all of the ones floating around seem to be like 20+ years old and are CLI based. I really think they could make a comeback in the hamsphere if someone would just build a modern one.

Thanks for getting back to me, I really love this project and how easy it made building and sending an AX.25 frame.