Demonstration: How to Customize and Build OpenBeken Firmware Directly in Your Browser

Thanks for your good work to make a more detailed documentation on how to use this feature.

I hope it's o.k. if I add some more information by showing a different approach on how to do the same change for this firmware with a "simple" sed command.

I wanted it to make as simple as possible, so you can even use it if you have only limited possibilities to add something to the repository, e.g. if you are using a smartphone w/o a real keyboard.
In this case I prefer to do as much as possible by copying and avoid text input if ever possible.

So the first challenge is to get the path to the code file you want to change.
My proposal is to navigate to this file in the git tree.
There you use the "copy path" and have it in your clipboard (relative to the SDKs home):




we only need to prepend the rest of the path from App-directory to the sdk to get the final path:



Alternatively you can simply copy the path from the browser URL and remove the unneded part.

While we are here at the location of the file, let's check the line we want to change.
First use browsers "search" to look for [BK_PARTITION_RF_FIRMWARE]
(additional information we get: There is only one match, thats good if we e.g. want to change a value that is present multiple times in the file)!


Inside this code block, we want to do the change:

$$\texttt{ .partition_start_addr = 0x1D0000,}$$

should be changed to

$$\texttt{.partition_start_addr = 0x1E3000,}$$

so a quick second search:

even the value $$\texttt{ 0x1D0000,}$$ is unique, so we can simply generally change "all" occurrences of
$$\texttt{ 0x1D0000,}$$ to $$\texttt{ 0x1E3000,}$$ and will not break anything else with only one simple sed line.

So this is what we have at the moment:

The path to the file we want to change (we prepended sdk/OpenBK7231N/ to the path we copied):

sdk/OpenBK7231N/platforms/bk7231n/bk7231n_os/beken378/func/user_driver/BkDriverFlash.c

we combine this with the sed to a simple script (and add some output, just to check what we have done):



As I said, this is a special case, we know the replacement of all values will only change the single line.
But in a more general approach we could combine the replacement with a "range" or even a line inside the file to make sure, we only change the value(s) we want to be changed.
In this case we see the line to change is line 70, so we can use this sed command to only replace this line

If we don't need the file path several times, we could also combine it to a single line:



This line is the minimum needed in the script to make this approach work, everything else is comment or debug output.

Now we know what to do to change the file the way we want and can start.

You need to be signed in to git to do the next steps!

Navigate to the git URL for OpenBeken:

https://github.com/openshwprojects/OpenBK7231T_App

and fork the repository with "+ create a new fork"


Assuming this is your first approach, you will need to activate "workflows" once:
So open "your" fork and as the very first step go to the "Actions" tab.
If you read:

"Workflows aren’t being run on this forked repository"

That's not what we want, since the workflows are exactly what you need to get our (online) build to be done. So allow workflows with the button "I understand my workflows, go ahead and enable them".


After that, return to "Code" again - you are ready for your change to the code now.
To bring the script to work, navigate to the git folder with the pre_build.sh (in platforms/BK7231N):



Here use "edit in place":

You can append the script at the end of the comments (that's easy e.g. on a phone), or simply delete the content and only paste your new script there:


And then commit the change you made. Give some additional information, if you like an decide, if you want to create a new branch (e.g. if you later plan to do other changes on the "original" fork) or simply change main branch (let's do this here).

That's it, we have done our work. So what now?

Action(s) is what we want
So go to "Actions" again and you should see there is something going on .

You can click the link of our commit to see some details.

Now you will need some patience until everything is done, but you can take a look for "your" platform BK7231N, and see, what happened during "make":


That looks good, so when everything is done, you can use the resulting "Artifacts" to get the firmware you made.

Go back to the "Summary" page and find the desired file at the end of the page.

In the downloaded zip, there is the result of our work, the firmware for BK7231N with changed values!


Done!

nice! even easier!

thank you

divadiow wrote:

Occasionally a device comes up that can only be partially made working with the standard firmware. Devices like the TH03 temperature and humidity sensor with segment display driven by a GN6932. To save space, the GN6932 driver was disabled by default.

this was a bad example. TMGN enablement only requires a change to the main app https://github.com/openshwprojects/OpenBK7231T_App/pull/1469