Skip to content

example: new example demonstrating an ASK modulator#28

Merged
dpks2003 merged 8 commits intovicharak-in:mainfrom
WasteOfO2:main
Dec 23, 2025
Merged

example: new example demonstrating an ASK modulator#28
dpks2003 merged 8 commits intovicharak-in:mainfrom
WasteOfO2:main

Conversation

@WasteOfO2
Copy link
Contributor

Added a new example demonstrating an Amplitude Shift Key modulator using both - the FPGA and the microcontroller.

Part of the README was made using assistance of LLMs, but has been confirmed to be valid and correct.

I am not sure if a video is necessary demonstrating the same, if needed will add it for reference

The example consists of the project file, source for the verilog code alongside the testbench for verification, python script for input or whatever code is to be actually transmitted and lastly, the bitstream to note the output for the same

Please do let me know if any additional changes are needed, thank you!

@dpks2003
Copy link
Collaborator

Hello @WasteOfO2 Thank you for Contribution.
We will review your PR now.

Copy link
Collaborator

@dpks2003 dpks2003 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check the comments and do the required changes.

@@ -1,5 +1,3 @@
(shrike_cli_guide)=
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this change is disruptive as it needed fro sphinex to render it properly. Revert this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will do

Onces the fpga is flashed you should see the led connected to fpga blinking.

The mpremote has a lot more features as well you can check them all out in there guide [here](https://docs.micropython.org/en/latest/reference/mpremote.html#).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will suggest completely reverting any changes in this file.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will do

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert this file these changes does not need's to be committed.
Just reset this file to current main.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i just directly copy pasted from what it currently is upstream as i figured that would be easier, in case that isnt sufficient i will just revert it as usual

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please revert it as copy pasting will still get into git log which , will rebuild the docs without any real changes. I hope you understand.

@@ -0,0 +1,67 @@
`timescale 1ns / 1ps

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is the difference between main_tb.vt and main_tb.v

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, i forgot to remove the older file as it didnt work as expected, will remove all the unnecessary files in the coming commit

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A proper file name would be needed here bruh.v is cool however unacceptable for a pr

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

my bad, this file was not supposed to exist here

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is there a main_tb.v in the src file.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no idea, will be removed right away

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

again proper naming and this should into a firmware subfolder in your project folder checkout ultrasonic example for reference

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a proper name for this file and name the dir as micropython instead of python_script

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

directory can be renamed, however i would want to know what other name can be used instead of helloshrike.py as i named it after the sequence that should be shown on the DSO/CRO

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe ask_modulator.py would be a better name and in the comments in teh file you can mention it send's hello word.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

again the user should be sure what example they are running so proper naming here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will be renamed right away

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.bin file or bit-stream are not required in the repo they should be generated by user.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will remove this, kept it as a working reference for users willing to just flash and get the desired output

@dpks2003 dpks2003 added fpga Issue in the FPGA side of the Shrike RP2040 issue in the RP2040 side of shrike. examples labels Dec 16, 2025
@dpks2003
Copy link
Collaborator

@WasteOfO2 your implementation is fine however the PR requires clean up , have added comments for that please do the needful.

Remove obsolete simulation sources and binary bitstream, rename the
ffpga file, and move helloshrike.py into the firmware/python_script
path.
@WasteOfO2
Copy link
Contributor Author

@dpks2003 kindly review the changes, let me know if further changes are needed

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a proper name for this file and name the dir as micropython instead of python_script

Onces the fpga is flashed you should see the led connected to fpga blinking.

The mpremote has a lot more features as well you can check them all out in there guide [here](https://docs.micropython.org/en/latest/reference/mpremote.html#).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert this file these changes does not need's to be committed.
Just reset this file to current main.

@WasteOfO2
Copy link
Contributor Author

@dpks2003 changed the directory name as requested, do suggest a naming convention for firmware be it for micropython, arduino, etc files so it can be ironed out down the line

Onces the fpga is flashed you should see the led connected to fpga blinking.

The mpremote has a lot more features as well you can check them all out in there guide [here](https://docs.micropython.org/en/latest/reference/mpremote.html#).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please revert it as copy pasting will still get into git log which , will rebuild the docs without any real changes. I hope you understand.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe ask_modulator.py would be a better name and in the comments in teh file you can mention it send's hello word.

@dpks2003
Copy link
Collaborator

@dpks2003 changed the directory name as requested, do suggest a naming convention for firmware be it for micropython, arduino, etc files so it can be ironed out down the line

sure @WasteOfO2 i am working on a contribution guide which will have all the conventions and guideline.

Thank You

@dpks2003
Copy link
Collaborator

also suggesting you to squash all of these in a single commit .

@WasteOfO2
Copy link
Contributor Author

hello @dpks2003 , sorry i was traveling so couldnt get back to this

multiple commits other than mine were made in this duration, are you fine with me squashing those as well?

@WasteOfO2
Copy link
Contributor Author

Seem to have squashed them locally but I am not sure if github has reflected that, never really worked with squashing before so i apologize

@dpks2003
Copy link
Collaborator

@WasteOfO2 it did not work no worries i will do it will merging.
Thank You for the contribution . Your PR will be merged soon

@dpks2003 dpks2003 merged commit d2d4d3f into vicharak-in:main Dec 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

examples fpga Issue in the FPGA side of the Shrike RP2040 issue in the RP2040 side of shrike.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants