Go Down

Topic: How to use THIS section of the FORUM (Read 6398 times) previous topic - next topic

ballscrewbob

Mar 01, 2017, 03:32 pm Last Edit: Oct 09, 2017, 03:57 am by ballscrewbob
Welcome to the ONLINE EDITOR...

How to use this section of the forum - please read.

Before you start please ask yourself if you followed the The getting started completely.
SELECT THE PLUGIN OPTION !



1. Basic information needed

This is the CREATE ONLINE EDITOR section.
Please try to include the following information in your post.

• Your computer operating system and version. E.g. Windows 10 pro x 64.
• Your Browser information such as Chrome Version 56.0.2924.87 (64-bit).
• The type of Arduino you are using (clones are accepted).
• Does your board work on the regular DESKTOP IDE (If so please include the version).
• Actual problem description ?
"Same here" or "Me too" do not really help anyone as there are so many differences between
computers so often a similar looking problem may be something entirely different.
• Types of USB port being used with the Arduinos ?
A lot of USB 3.0 ports can cause issues (not all) If you only have USB 3.0 and are having
intermittent connection issues try insert a USB 2.0 powered hub between the computer and
the  Arduino as that is known to fix a few issues.
• Copies of any error reports seen. PLEASE use code tags </> to post those errors
• If your issue concerns a sketch on CREATE PLEASE supply a link to that sketch. You can use the SHARE option to get your link.

NEVER HIJACK somebody else's thread or DUPLICATE your post elsewhere !
This is frowned upon and can result in problems getting the correct answer always start your own thread.


Other things to try to get a bit more information.
Before loading any sketches go straight to PREFERENCES and turn on ALWAYS SHOW OUTPUT PANEL and CONSOLE SHOW VERBOSE OUTPUT"



If there is anything in the lower console you can copy it out and paste it back here



2. Do some research before posting

Try to solve your problem, or answer your question, yourself. For example, if you are wondering how to connect an ESP8266, try Googling exactly that by using the term "arduino create editor esp8266 " to narrow things down.



The above example gave lots of hits. Read some of them, perhaps your question has already been answered.

Remember that the people trying to help you are just Arduino users like you. Try to help them in order to best help yourself

If that doesn't help, try browsing existing threads in the forum for a while. Maybe what you are asking is currently under discussion in another thread.


3. Click on the New Topic button



4. Make a meaningful subject line

Try to summarize your problem with a helpful and informative subject line. Helpful subjects draw in people who might know the answer. Unhelpful ones are likely to be skipped.

Examples of unhelpful subject lines:
• Noob here, help needed
• Help me, quickly!
• Got error
• Lost, help me
• Problem with my circuit
• No idea what I am doing



In particular avoid subject lines in ALL CAPITALS. That annoys a lot of people, they feel as if you are shouting at them.

For code, error messages, program output, etc. select the code, and click the "Insert code" button, as shown



This makes the code much more readable, and also stops the forum eating your code or changing characters as they may be interpreted as control characters.



If you click the "Preview" button under your post you'll see what the code tags have done, and can check everything looks OK before posting:



6. You can add attachments

If your code is too long to fit into a post, or you have multiple files (e.g. code and libraries), or you want to show an image, click on the Additional Options button:



Then you can browse your hard disk for the image, code, schematic, photo, that you want to attach.

Please resize photos down to a reasonable size. A 4 megabyte photo takes a long time to download. As a courtesy to other forum users, images should be no more than a couple of hundred K bytes. If your picture is too large you will be notified. In that case open your favourite picture editor and select the resize option. Try 75% to start and if it is still too large try 75 % again. Don't forget to save your reduced image with a new file name e.g. Connection error screenshot crop 01 and Connection error screenshot crop 02 etc.

7. You can insert images

If you have an image hosted on your own (or a public) site, you can embed the image directly inside the post, for example:



8. Post in proper sentences

This is a forum you are using, not a mobile phone or Facebook.

As a courtesy to the people you are hoping to have help you, type complete sentences. That is:

• Start with a capital letter.
• Spell words properly.
• Finish with a period (full-stop). (Just the one, thanks!)

Taking the time to make a proper, punctuated, post is a mark of courtesy and respect. It will improve your chance of a response.

9. Tips for getting the most out of your post

• Mention which Arduino you have. Is it a Uno? Leonardo? Due? Mini? Mega?
The problem might be specific to a certain model.
• Describe your problem in detail.
• If it relates to an electronics part (chip or board), give the exact part number and preferably
a link to the data sheet.
• Describe how you have connected things like switches. Are they wired to ground? Or +5V?
Are there pull-up or pull-down resistors? Post a circuit if there is doubt.
• Post a complete sketch (program code)! If you don't you waste time while people ask you to do that.
However, with coding problems, if possible post a "minimal" sketch that demonstrates the problem
not hundreds of lines of code. If the problem goes away in the minimal sketch, it wasn't where you
thought it was.
• Copy and paste code. Don't retype "from memory" on your mobile phone, in the train.
• If you get an error, post the error (copy and paste). Not just "I got an error".
• If you have debugging information in your sketch, post your debugging displays.
• If you are using a library that does not come with the IDE (in other words, you downloaded it
from somewhere) please post a link to this library.
• Describe what you expected to happen, and what actually happened. Not just "it doesn't work".
• If possible, describe what you are really trying to do, not what you think might work. For example
"I am trying to turn on an aquarium heater and pump at the same time", not "how do I break out of
an interrupt?".
• Try to narrow down the problem, whether coding or electronic. Don't confuse us and yourself by
trying to do everything at once. For example, if you are having problems reading a sensor,
make up a simple test case, that tests that sensor (both electrically and in code).
• Put your location (country) in your forum profile. That allows answers to better help you with
mains voltages, local suppliers, and other local issues.
It may not be the answer you were looking for but its the one I am giving based on either experience, educated guess, google or the fact that you gave nothing to go with in the first place so I used my wonky crystal ball.

ballscrewbob

#1
Mar 01, 2017, 03:57 pm Last Edit: Mar 18, 2017, 05:12 am by Ballscrewbob
10. Don't "message" technical questions to people

The messages part of the forum is for personal messages. Not technical questions.

It is not appropriate to find someone who you think might be able to help, and try to get one-on-one personal assistance. If you do, I suggest you be prepared to pay for such personal help.

If you are really keen to get the attention of what appears to you to be an expert in your problem, post a forum question first (as described above).

Then wait a day or two. That person may be busy. If they haven't answered by then, and if no-one else has been able to help you, you could send a brief message politely asking for assistance, including the URL (link) of the forum thread.

If you don't post a link to the forum question, the person you are asking for help has to try to work out where it is, and the time and effort involved may slow down, or stop, their response.

Note that generally questions posted on the forum are answered within the hour, by someone or other. Asking a particular person to help may cause at least an 8-hour delay, if they happen to be asleep, at work, out fishing or whatever they are doing.

11. Forum etiquette

Once you have made your post, here are a few other guidelines:

Don't cross-post!
We know you are anxious to get an answer to your problem, but re-posting the same question to multiple parts of the forum causes duplicate effort, and divides the focus on your problem. You'll get a better answer if everyone can discuss it in one place. Cross-posting is very annoying; the moderators will delete your extra posts, and you will get a warning. Save all the hassle, and just post the question once. It will be noticed.

If you aren't sure what section to post in (Programming Questions, Electronics, etc.) make a guess. Don't cross post "just in case".

Don't bump!
Don't bump your thread after an hour. Because of the different time-zones the person who knows the answer may be asleep, or away for the day. Maybe after a couple of days.

If your question didn't get an answer, honestly review it to see if you posted enough information to help people answer you. Did you even ask a question?

People are trying to help
If someone asks for more details, they are probably trying to visualize what you are attempting to do. Don't fob them off with "that's irrelevant" sort of responses. The more detail about your project, the better the help you will get.

Keep your signature short
A signature should be preferably one line, and relevant. A signature that links to some unrelated-looking site (like football competitions) is likely to get you banned as a spammer. To keep bandwidth down, no images, thanks.

Be polite
A little courtesy and politeness goes a long way. Even if you think a question has been asked before, or you don't see the point of it, try to answer politely. Remember a lot of the posters with high post counts see the same questions every day, and they may get a bit terse if you appear not to have tried very hard to help yourself in the first place. You will find that if you respond in a friendly way, people will stick with you and you will almost certainly get your problem solved. Personal insults are not acceptable. Stick to the topic.

12. Once you have a response ...

You will probably quickly get some helpful suggestions. Read them carefully.

• If a reply mentions something you don't understand (e.g. "shift register") try to find out for yourself what that means, by using Google.
• If you don't understand part of a reply, say so. Say which part. Don't just ignore it.
• Apply suggested fixes, even if they don't seem relevant to you. Seemingly insignificant changes might actually solve your problem.
• Look for hints about what is wanted. For example: "what code?" means: "Please post your code."
• If you make changes, and things still don't work, post the changed code (or wiring) as appropriate (in a new reply).
• Answer questions. It is frustrating to have to take three pages of a thread to drag out of someone what code they are using, or what their wiring is.
• Except for adding code tags, please don't modify earlier posts to make corrections. That makes the following posts read strangely. Post the modified code in a new reply.
• Once you have solved your problem, do not delete the thread! The forum is supposed to be a knowledge-base. Deleting a thread once you are happy does not help future people with similar problems. Nor should you replace your original post with something meaningless like a dot.
• Similarly, if you have worked the problem out, as a courtesy to other people reading the thread later, explain what you changed that made it work (e.g. post the corrected circuit, or corrected code).
• If you consider the issue solved, please edit your original post (the first one in the thread) and add "[solved]" to the subject line. That helps people know the issue is resolved. Also please post the solution, whether you worked it out yourself, or if someone else helped you. A note that "this was solved by doing X" is very helpful to other people with the same problem. Thanks!

"Thanks to Nick Gammon as this is based on his forum guide"


Attached below is this forum post, a suggestion for cleaning up if you are changing IDE's, Ideas to get ready to import sketches and libraries.  ALL in PDF format.
It may not be the answer you were looking for but its the one I am giving based on either experience, educated guess, google or the fact that you gave nothing to go with in the first place so I used my wonky crystal ball.

Go Up