Bristlemouth API Tool Testers Wanted

Community
1

Hi there folks-- I talked with @Caesarh who wanted to know if anybody had a chance to test out the Aqualink-built data parser https://bristlemouth.aqualink.org/.

Take a look and if you can provide us with any feedback we’d appreciate it!

screenshot-bristlemouth_aqualink_org-2024_12_05-16_10_57
screenshot-bristlemouth_aqualink_org-2024_12_05-16_10_571127×859 78.6 KB

Z

2

I tested it out while working on integrating our pH sensor.
It is a nice tool and quite handy to use, but is limited by the decoder options.
I had to ultimately write my own decoder since I was passing data in a custom format.

It would be nice to have the ability to upload your own decoder format and use it to visualize the data.

3

I agree! Maybe you can add it to the repo: bristlemouth-explorer/src/decoders at main · aqualinkorg/bristlemouth-explorer · GitHub?

@Caesarh do you have any guidance on how someone should approach this?

Z

4

Hi @GautamB,

Sorry for the delay. Thank you for testing out the tool and for sharing such valuable feedback! I’m glad to hear you found it handy, even though the decoder limitations presented some challenges.

We’re always looking to improve the platform. While we explore the possibility of implementing this feature, if you or anyone else in the Bristlemouth community would like to contribute to the code with decoders, enhancements, or other features, we’d greatly appreciate it! The relevant section of the codebase is here: bristlemouth-explorer/src/decoders.

If you need any guidance or run into issues, feel free to reach out to us at admin@aqualink.org, and we’ll connect you with our developer for support.

Thank you again for sharing your experience, and I hope you had a wonderful holiday season!

Best regards,
Caesar

1 Like
5

Hi again @GautamB,

Here’s a short guide on uploading your own decoder format to the Bristlemouth Explorer.

New decoders can easily be added to the app by submitting a pull request in this repository, following these steps:

  1. Create a new file under src/decoders and export the new decoder. Ensure that your decoder implements the Decoder interface. You can refer to src/decoders/default.ts as an example
  2. Import and append the new decoder to the decoders variable at the end of src/helpers/decoder.ts file

Once your pull request is merged, your new decoder will become accessible in the drop-down list, just like the existing ones!

Please let me know how it goes if you try it :slight_smile:

Thank you,
Caesar