Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create How_To_Use_OpenOCD_UbuntuEd #47

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

afrojedi
Copy link

No description provided.

Copy link
Owner

@profezzorn profezzorn left a comment

Choose a reason for hiding this comment

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

This is only the first set of comments.
There is quite a lot of work to do to make this helpful and good.
I expect this to take a few passes, first fixing the big stuff, then smaller and smaller stuff until we can add it in.

Be thankful that this is just documentation, I'm much more picky about code... :)

---
title: Openocd On Ubuntu 64
redirect_from:
- /Openocd.html
Copy link
Owner

Choose a reason for hiding this comment

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

Why do we need a redirect from /Openocd.html?
redirect_from is usually only used when a page is moved.

@@ -0,0 +1,67 @@
---
Copy link
Owner

Choose a reason for hiding this comment

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

The filename should end with ".md" (markdown) which gets converted to html when it gets deployed on pod.hubbe.net.

Also, the file names are generally lower case (the title doesn't have to be though.)

@@ -0,0 +1,67 @@
---
title: Openocd On Ubuntu 64
Copy link
Owner

Choose a reason for hiding this comment

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

I think just call it "OpenOCD on Linux"

Then add a note below which specifies exactly what platform you used and tell people that something similar should work on other linux platforms.

redirect_from:
- /Openocd.html
---
This How to covers, if I rip my usb how do I flash the Proffieboard or update it. there's a few things about this particular use case. In this article you will be using the ST-Linkv2 usb debugger that connects through single core and the operating system of your laptop or pc would be Ubuntu 64 bit or any linux distro that is 64 bit.
Copy link
Owner

Choose a reason for hiding this comment

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

How to -> how-to

there's a few things about this particular use case.

This sentence doesn't make sense to me.
What few things?
Also, it's not capitalized.

redirect_from:
- /Openocd.html
---
This How to covers, if I rip my usb how do I flash the Proffieboard or update it. there's a few things about this particular use case. In this article you will be using the ST-Linkv2 usb debugger that connects through single core and the operating system of your laptop or pc would be Ubuntu 64 bit or any linux distro that is 64 bit.
Copy link
Owner

Choose a reason for hiding this comment

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

"connects through single core"
what does that mean?

```

pre-requisites
the hardware required is the ST-Linkv2 debugger USB, plus the male/female pinned cables and small pcb test points connect the female pins into the usb pins that correspond with 1. sdio 2. swdlck and 3 gnd. the male end will go to the corresponding pins on the proffieboard. use the pcb test points to hold the pins in place other wise the connection may be lost during the compiling stage.
Copy link
Owner

Choose a reason for hiding this comment

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

We could really really use an illustration or image on how this should be wired up.

pre-requisites
the hardware required is the ST-Linkv2 debugger USB, plus the male/female pinned cables and small pcb test points connect the female pins into the usb pins that correspond with 1. sdio 2. swdlck and 3 gnd. the male end will go to the corresponding pins on the proffieboard. use the pcb test points to hold the pins in place other wise the connection may be lost during the compiling stage.

1. Verify configuration in Arduino IDE and locate the file (ProffieOS.ino.elf) in the /tmp folder this can be found if you have debug enabled in the arduino preferences for the option of compiling. copy the hole output from arduino and then paste into a text file and run a search on the filename. e.g. "/tmp/arduino_build_610194/ProffieOS.ino.elf"
Copy link
Owner

Choose a reason for hiding this comment

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

We how to tell people how to locate the build folder.
(Either tell people to find it in the compile output, or use a "find" command.)

4. in the terminal run the following command

```
openocd -f /home/max/.arduino15/packages/proffieboard/hardware/stm32l4/3.6.0/variants/STM32L433CC-Proffieboard/openocd_scripts/stm32l433cc_butterfly.cfg -c “program ./ProffiOS.ino.elf verify reset ext”
Copy link
Owner

Choose a reason for hiding this comment

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

replace /home/max with $HOME so it will work for everybody.

openocd -f /home/max/.arduino15/packages/proffieboard/hardware/stm32l4/3.6.0/variants/STM32L433CC-Proffieboard/openocd_scripts/stm32l433cc_butterfly.cfg -c “program ./ProffiOS.ino.elf verify reset ext”
```

a successfuly compiling looks like this.
Copy link
Owner

Choose a reason for hiding this comment

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

"compiling" is the wrong word here.
Arduino does the compilation (which means turning source code into binary code) this command just does the upload to the board.

redirect_from:
- /Openocd.html
---
This How to covers, if I rip my usb how do I flash the Proffieboard or update it. there's a few things about this particular use case. In this article you will be using the ST-Linkv2 usb debugger that connects through single core and the operating system of your laptop or pc would be Ubuntu 64 bit or any linux distro that is 64 bit.
Copy link
Owner

Choose a reason for hiding this comment

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

Overall, the structure of the text needs some work.
It reads more like "this is what I did" than "this is what you should do".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants