From 1d087a25b025b01122961cedc5d9d88651949498 Mon Sep 17 00:00:00 2001 From: Dan Trickey Date: Fri, 9 Aug 2019 19:13:23 +0100 Subject: [PATCH 01/19] Add Kit Tutorial, without photos. --- docs/source/tutorials/connecting-your-kit.rst | 124 ++++++++++++++++++ 1 file changed, 124 insertions(+) create mode 100644 docs/source/tutorials/connecting-your-kit.rst diff --git a/docs/source/tutorials/connecting-your-kit.rst b/docs/source/tutorials/connecting-your-kit.rst new file mode 100644 index 00000000..a0c6cbd1 --- /dev/null +++ b/docs/source/tutorials/connecting-your-kit.rst @@ -0,0 +1,124 @@ +Connecting Your Kit +=================== + +Essential hardware +------------------ + +- Raspberry Pi (the board in a plastic case with many USB ports) +- Power Board (the board in a plastic case with many green sockets and + two buttons) +- Motor Board (the board in a plastic case with three outputs on one end) +- Servo Board (the board in a plastic case with many pins on the side) +- Arduino (a board with a metal USB-B connector and a long 30 pin chip) +- Battery (will be provided later.) +- USB Hub + +Connectors and cables +--------------------- + +- 2 x 3.81mm CamCon (for the Raspberry Pi) +- 4 x 5mm CamCon (for the Motors) +- 1 x 5mm CamCon with wire loop (attached to the power board) +- 4 x 7.5mm CamCon (for the Motor and Servo Boards) +- 3 x USB-A to micro-USB cables +- USB-A to USB-B cable (for the Arduino) +- Wire + +Peripherals +----------- + +- Servos +- Ultrasound Sensors +- USB Flash Drive + +Tools you’ll need +----------------- + +- Pliers +- Wire Cutters +- Wire Strippers +- Screwdriver (2mm flat-head) +- 2 x Motor + +You will need to obtain any other needed tools/supplies yourself. + +.. Hint:: *CamCons* are the `green connectors `__ + used for power wiring within our kit. + +Important notes before you start +-------------------------------- + +.. Warning:: Make sure to read all these **before** you start assembly. + +- Do not disassemble/reassemble your kit without first switching it off + and unplugging the battery and check it thoroughly before plugging it + in and switching it on again (don’t be afraid to ask someone to check + your kit before you do so). If something is connected up incorrectly when + the kit is powered up, it may damage the components. + +- When wiring CamCons (or anything at all, but CamCons in particular), + always double-check that the correct connections are made at either + end (positive to positive, ground to ground, etc.) before plugging in + the cable or plugging in the battery or switching things on.. + Don’t be afraid to ask someone to check your connections. + +- Colour coding is key; please use *red* for wires connected to + a powered rail (say 12V or 5V), *black* for wires connected to ground + (0V rail) and *blue* for motors. + +How it all fits together +------------------------ + +1. Connect the Raspberry Pi to the Power Board using two 3.81mm CamCons. + Please make sure that you check the polarity of the connector on the tab. +2. Connect the USB hub to the Pi by plugging it into any one of its + four USB sockets. +3. Connect the Power Board to the Pi via one of the black micro-USB + cables; the standard USB end goes into any USB socket on the Pi or + connected USB hub, the micro-USB end into the Power Board. +4. Connect the Motor Board to the Power Board by screwing the two large + (7.5mm) CamCons provided onto the opposite ends of a pair of wires, + ensuring that positive connects to positive and ground to ground, + and then plugging one end into the appropriate socket of the Motor + Board and the other into a high power socket (marked H0 or H1) + on the side of the Power Board. +5. Connect the Motor Board to the Pi by way of another black + micro-USB cable; the USB A end goes into any USB socket on + the Pi or connected USB hub, the micro-USB end goes into the Motor + Board. +6. Connect the Arduino to the Pi by way of the USB-A to USB-B + cable; the square-ish USB-B end goes into the appropriate + metal-cased connector on the Arduino, the standard USB end goes into + any free USB port on the Pi. + +.. Warning:: If the Arduino is not connected directly to the Pi, you may + suffer from power stability issues. + +4. Connect the Servo Board to the Power Board by screwing the two large + (7.5mm) CamCons provided onto the opposite ends of a pair of wires, + ensuring that positive connects to positive and ground to ground, + and then plugging one end into the appropriate socket of the Motor + Board and the other into any socket on the side of the Power Board. +5. Connect the Servo Board to the Pi by way of another black + micro-USB cable; the USB A end goes into any USB socket on + the Pi or connected USB hub, the micro-USB end goes into the Servo + Board. + +8. To connect the motors, first screw two medium (5mm) CamCons provided + onto the opposite ends of a pair of wires. You can then use this cable + to connect a motor to the ``M0`` or ``M1`` port on the motor board. + +10. To connect a servo, push the three pin connector vertically into the + pins on the side of the servo board. The black or brown cable (negative) + should be at the bottom. + +9. At this point, check that everything is connected up correctly (it + may be helpful to ask someone around you to check that all cables + are connected properly). +10. Connect the Power Board to one of the blue LiPo batteries by + plugging the yellow connector on the cable connected to the Power + Board into its counterpart on the battery. +11. If there is not one plugged in already, a loop of wire should be + connected to the socket beneath the On|Off switch. Check that the + Power Board works by pressing the On|Off switch and checking that + the bright LED on the Raspberry Pi comes on green. From a9aa1d31d914acdbb06ccd8a07b275a13de36f4d Mon Sep 17 00:00:00 2001 From: Dan Trickey Date: Fri, 9 Aug 2019 19:22:47 +0100 Subject: [PATCH 02/19] Fix formatting on kit build tutorial --- docs/source/tutorials/connecting-your-kit.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/source/tutorials/connecting-your-kit.rst b/docs/source/tutorials/connecting-your-kit.rst index a0c6cbd1..496ea170 100644 --- a/docs/source/tutorials/connecting-your-kit.rst +++ b/docs/source/tutorials/connecting-your-kit.rst @@ -80,7 +80,7 @@ How it all fits together (7.5mm) CamCons provided onto the opposite ends of a pair of wires, ensuring that positive connects to positive and ground to ground, and then plugging one end into the appropriate socket of the Motor - Board and the other into a high power socket (marked H0 or H1) + Board and the other into a high power socket (marked ``H0`` or ``H1``) on the side of the Power Board. 5. Connect the Motor Board to the Pi by way of another black micro-USB cable; the USB A end goes into any USB socket on @@ -94,17 +94,17 @@ How it all fits together .. Warning:: If the Arduino is not connected directly to the Pi, you may suffer from power stability issues. -4. Connect the Servo Board to the Power Board by screwing the two large +7. Connect the Servo Board to the Power Board by screwing the two large (7.5mm) CamCons provided onto the opposite ends of a pair of wires, ensuring that positive connects to positive and ground to ground, and then plugging one end into the appropriate socket of the Motor Board and the other into any socket on the side of the Power Board. -5. Connect the Servo Board to the Pi by way of another black +8. Connect the Servo Board to the Pi by way of another black micro-USB cable; the USB A end goes into any USB socket on the Pi or connected USB hub, the micro-USB end goes into the Servo Board. -8. To connect the motors, first screw two medium (5mm) CamCons provided +9. To connect the motors, first screw two medium (5mm) CamCons provided onto the opposite ends of a pair of wires. You can then use this cable to connect a motor to the ``M0`` or ``M1`` port on the motor board. @@ -112,13 +112,13 @@ How it all fits together pins on the side of the servo board. The black or brown cable (negative) should be at the bottom. -9. At this point, check that everything is connected up correctly (it - may be helpful to ask someone around you to check that all cables - are connected properly). -10. Connect the Power Board to one of the blue LiPo batteries by +11. At this point, check that everything is connected up correctly (it + may be helpful to ask someone around you to check that all cables + are connected properly). +12. Connect the Power Board to one of the blue LiPo batteries by plugging the yellow connector on the cable connected to the Power Board into its counterpart on the battery. -11. If there is not one plugged in already, a loop of wire should be +13. If there is not one plugged in already, a loop of wire should be connected to the socket beneath the On|Off switch. Check that the Power Board works by pressing the On|Off switch and checking that the bright LED on the Raspberry Pi comes on green. From 8aed66b991efe5d4787a596c116971c461585e85 Mon Sep 17 00:00:00 2001 From: Dan Trickey Date: Sun, 11 Aug 2019 15:25:46 +0100 Subject: [PATCH 03/19] More tutorial --- docs/source/tutorials/connecting-your-kit.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/tutorials/connecting-your-kit.rst b/docs/source/tutorials/connecting-your-kit.rst index 496ea170..8cf6c796 100644 --- a/docs/source/tutorials/connecting-your-kit.rst +++ b/docs/source/tutorials/connecting-your-kit.rst @@ -113,8 +113,8 @@ How it all fits together should be at the bottom. 11. At this point, check that everything is connected up correctly (it - may be helpful to ask someone around you to check that all cables - are connected properly). + may be helpful to ask someone around you to check that all cables + are connected properly). 12. Connect the Power Board to one of the blue LiPo batteries by plugging the yellow connector on the cable connected to the Power Board into its counterpart on the battery. From 4cd71c8a2b6856773122e651256a4bd1ab4207df Mon Sep 17 00:00:00 2001 From: Andrew Barrett-Sprot Date: Sun, 11 Aug 2019 19:21:57 +0200 Subject: [PATCH 04/19] big update on all of the docs --- docs/source/tutorials/connecting-your-kit.rst | 107 +++++++++--------- 1 file changed, 54 insertions(+), 53 deletions(-) diff --git a/docs/source/tutorials/connecting-your-kit.rst b/docs/source/tutorials/connecting-your-kit.rst index 8cf6c796..f16a2db1 100644 --- a/docs/source/tutorials/connecting-your-kit.rst +++ b/docs/source/tutorials/connecting-your-kit.rst @@ -4,13 +4,13 @@ Connecting Your Kit Essential hardware ------------------ -- Raspberry Pi (the board in a plastic case with many USB ports) -- Power Board (the board in a plastic case with many green sockets and +- Raspberry Pi (the board with many USB sockets, HDMI and microUSB) +- Power Board (the board with a fan, many green sockets and two buttons) -- Motor Board (the board in a plastic case with three outputs on one end) -- Servo Board (the board in a plastic case with many pins on the side) +- Motor Board (the board with three green sockets on one end) +- Servo Board (the board with many pins on the side) - Arduino (a board with a metal USB-B connector and a long 30 pin chip) -- Battery (will be provided later.) +- a Battery (will be provided later) - USB Hub Connectors and cables @@ -24,12 +24,16 @@ Connectors and cables - USB-A to USB-B cable (for the Arduino) - Wire +.. Hint:: *CamCons* are the `green connectors `__ + used for power wiring within our kit. + Peripherals ----------- -- Servos -- Ultrasound Sensors -- USB Flash Drive +- Servo motor +- 2 x Motors +- Ultrasound distance sensors +- USB memory stick Tools you’ll need ----------------- @@ -38,80 +42,77 @@ Tools you’ll need - Wire Cutters - Wire Strippers - Screwdriver (2mm flat-head) -- 2 x Motor - -You will need to obtain any other needed tools/supplies yourself. -.. Hint:: *CamCons* are the `green connectors `__ - used for power wiring within our kit. +You will need to fetch any other needed tools/supplies yourself. Important notes before you start -------------------------------- .. Warning:: Make sure to read all these **before** you start assembly. -- Do not disassemble/reassemble your kit without first switching it off - and unplugging the battery and check it thoroughly before plugging it - in and switching it on again (don’t be afraid to ask someone to check - your kit before you do so). If something is connected up incorrectly when - the kit is powered up, it may damage the components. +- Do not disassemble/reassemble your kit without first switching it off by + pressing the red button. + +- Always be careful handling your battery, only ever plug it into the Power + board (the board with a fan). + +- Check your kit thoroughly before switching it on again. If something is + connected up incorrectly when the kit is powered up, it may break the kit! -- When wiring CamCons (or anything at all, but CamCons in particular), +- When making your own wires CamCons (or anything at all, but CamCons in particular), always double-check that the correct connections are made at either end (positive to positive, ground to ground, etc.) before plugging in - the cable or plugging in the battery or switching things on.. + the cable or plugging in the battery and switching things on. Don’t be afraid to ask someone to check your connections. - Colour coding is key; please use *red* for wires connected to - a powered rail (say 12V or 5V), *black* for wires connected to ground - (0V rail) and *blue* for motors. + power (say 12V or 5V), *black* for wires connected to ground + (0V) and *any other colour* for motors. How it all fits together ------------------------ -1. Connect the Raspberry Pi to the Power Board using two 3.81mm CamCons. - Please make sure that you check the polarity of the connector on the tab. +The first step of your robot is assembly! Here we'll guide you step-by-step on +how to connect things up. You'll be cutting your own wires here! + +1. Connect the Raspberry Pi to the Power Board using two 3.81mm (small) + CamCons. Please make sure that you check the polarity of the connector on + the tab. 2. Connect the USB hub to the Pi by plugging it into any one of its four USB sockets. 3. Connect the Power Board to the Pi via one of the black micro-USB cables; the standard USB end goes into any USB socket on the Pi or connected USB hub, the micro-USB end into the Power Board. -4. Connect the Motor Board to the Power Board by screwing the two large - (7.5mm) CamCons provided onto the opposite ends of a pair of wires, +4. Connect the Motor Board to the Power Board by screwing the two 7.5mm (large) + CamCons provided onto the opposite ends of a pair of wires, ensuring that positive connects to positive and ground to ground, and then plugging one end into the appropriate socket of the Motor Board and the other into a high power socket (marked ``H0`` or ``H1``) - on the side of the Power Board. -5. Connect the Motor Board to the Pi by way of another black - micro-USB cable; the USB A end goes into any USB socket on - the Pi or connected USB hub, the micro-USB end goes into the Motor - Board. -6. Connect the Arduino to the Pi by way of the USB-A to USB-B - cable; the square-ish USB-B end goes into the appropriate - metal-cased connector on the Arduino, the standard USB end goes into - any free USB port on the Pi. - -.. Warning:: If the Arduino is not connected directly to the Pi, you may - suffer from power stability issues. - -7. Connect the Servo Board to the Power Board by screwing the two large - (7.5mm) CamCons provided onto the opposite ends of a pair of wires, - ensuring that positive connects to positive and ground to ground, - and then plugging one end into the appropriate socket of the Motor - Board and the other into any socket on the side of the Power Board. -8. Connect the Servo Board to the Pi by way of another black - micro-USB cable; the USB A end goes into any USB socket on - the Pi or connected USB hub, the micro-USB end goes into the Servo - Board. - -9. To connect the motors, first screw two medium (5mm) CamCons provided + on the side of the Power Board. +5. Connect the Motor Board to the Pi by way of another micro-USB cable; the big + end goes into any USB socket on the Pi or connected USB hub, the micro-USB + end goes into the Motor Board. +6. Connect the Arduino to the Pi by way of the USB-A (rectangle) to USB-B + (hexagon) cable. + +.. Warning:: Please don't connect the Arduino to the Raspberry Pi via the + USB Hub. If the Arduino is not connected *directly* to the Pi, you may + have issues with getting enough power to it. + +7. Connect the Servo Board to the Power Board by screwing the two 7.5mm (large) + CamCons onto the opposite ends of a pair of wires, ensuring that positive + connects to positive and ground to ground, and then plugging one end into + the appropriate socket of the Motor Board and the other into any socket on + the side of the Power Board. +8. Connect the Servo Board to the Pi by way of another micro-USB cable; the + USB A (rectangle) end goes into any USB socket on the Pi or connected via + the USB hub, the micro-USB end goes into the Servo Board. +9. To connect the motors, first screw two 5mm (medium) CamCons provided onto the opposite ends of a pair of wires. You can then use this cable to connect a motor to the ``M0`` or ``M1`` port on the motor board. - 10. To connect a servo, push the three pin connector vertically into the - pins on the side of the servo board. The black or brown cable (negative) + pins on the side of the servo board. The black or brown wire (negative) should be at the bottom. - 11. At this point, check that everything is connected up correctly (it may be helpful to ask someone around you to check that all cables are connected properly). From 3281e9186e449a4d7b0c8ed965506e8e418d52f3 Mon Sep 17 00:00:00 2001 From: Kier Davis Date: Mon, 12 Aug 2019 09:42:43 +0100 Subject: [PATCH 05/19] Apply suggestions from code review https://vignette.wikia.nocookie.net/rickandmorty/images/9/9f/Scjerry.png/revision/latest?cb=20160111021222 --- docs/source/tutorials/connecting-your-kit.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/tutorials/connecting-your-kit.rst b/docs/source/tutorials/connecting-your-kit.rst index f16a2db1..b85ffeca 100644 --- a/docs/source/tutorials/connecting-your-kit.rst +++ b/docs/source/tutorials/connecting-your-kit.rst @@ -9,7 +9,7 @@ Essential hardware two buttons) - Motor Board (the board with three green sockets on one end) - Servo Board (the board with many pins on the side) -- Arduino (a board with a metal USB-B connector and a long 30 pin chip) +- Arduino (a board with a metal USB-B connector) - a Battery (will be provided later) - USB Hub @@ -53,13 +53,13 @@ Important notes before you start - Do not disassemble/reassemble your kit without first switching it off by pressing the red button. -- Always be careful handling your battery, only ever plug it into the Power +- Always be careful handling your battery, only ever plug it into the power board (the board with a fan). - Check your kit thoroughly before switching it on again. If something is connected up incorrectly when the kit is powered up, it may break the kit! -- When making your own wires CamCons (or anything at all, but CamCons in particular), +- When making your own wires, especially those with CamCons on the end, always double-check that the correct connections are made at either end (positive to positive, ground to ground, etc.) before plugging in the cable or plugging in the battery and switching things on. @@ -93,7 +93,7 @@ how to connect things up. You'll be cutting your own wires here! end goes into any USB socket on the Pi or connected USB hub, the micro-USB end goes into the Motor Board. 6. Connect the Arduino to the Pi by way of the USB-A (rectangle) to USB-B - (hexagon) cable. + (square-like) cable. .. Warning:: Please don't connect the Arduino to the Raspberry Pi via the USB Hub. If the Arduino is not connected *directly* to the Pi, you may @@ -102,7 +102,7 @@ how to connect things up. You'll be cutting your own wires here! 7. Connect the Servo Board to the Power Board by screwing the two 7.5mm (large) CamCons onto the opposite ends of a pair of wires, ensuring that positive connects to positive and ground to ground, and then plugging one end into - the appropriate socket of the Motor Board and the other into any socket on + a low power socket on the side of the Power Board and the other into any socket on the side of the Power Board. 8. Connect the Servo Board to the Pi by way of another micro-USB cable; the USB A (rectangle) end goes into any USB socket on the Pi or connected via @@ -114,7 +114,7 @@ how to connect things up. You'll be cutting your own wires here! pins on the side of the servo board. The black or brown wire (negative) should be at the bottom. 11. At this point, check that everything is connected up correctly (it - may be helpful to ask someone around you to check that all cables + may be helpful to ask a facilitator to check that all cables are connected properly). 12. Connect the Power Board to one of the blue LiPo batteries by plugging the yellow connector on the cable connected to the Power From 5ccc2a7b9cef2bd598e91aec8f806f59e1ad5834 Mon Sep 17 00:00:00 2001 From: Kier Davis Date: Mon, 12 Aug 2019 09:43:37 +0100 Subject: [PATCH 06/19] Apply suggestions from code review https://vignette.wikia.nocookie.net/rickandmorty/images/9/9f/Scjerry.png/revision/latest?cb=20160111021222 --- docs/source/tutorials/connecting-your-kit.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/tutorials/connecting-your-kit.rst b/docs/source/tutorials/connecting-your-kit.rst index b85ffeca..a6f75c74 100644 --- a/docs/source/tutorials/connecting-your-kit.rst +++ b/docs/source/tutorials/connecting-your-kit.rst @@ -8,7 +8,7 @@ Essential hardware - Power Board (the board with a fan, many green sockets and two buttons) - Motor Board (the board with three green sockets on one end) -- Servo Board (the board with many pins on the side) +- Servo Board (the square board with many pins on the side) - Arduino (a board with a metal USB-B connector) - a Battery (will be provided later) - USB Hub From f80207f1d8d2b9a85899501e0ce100f8612c7434 Mon Sep 17 00:00:00 2001 From: Dan Trickey Date: Mon, 12 Aug 2019 16:38:23 +0100 Subject: [PATCH 07/19] Fix typo --- docs/source/tutorials/connecting-your-kit.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/tutorials/connecting-your-kit.rst b/docs/source/tutorials/connecting-your-kit.rst index a6f75c74..36f446b8 100644 --- a/docs/source/tutorials/connecting-your-kit.rst +++ b/docs/source/tutorials/connecting-your-kit.rst @@ -102,8 +102,8 @@ how to connect things up. You'll be cutting your own wires here! 7. Connect the Servo Board to the Power Board by screwing the two 7.5mm (large) CamCons onto the opposite ends of a pair of wires, ensuring that positive connects to positive and ground to ground, and then plugging one end into - a low power socket on the side of the Power Board and the other into any socket on - the side of the Power Board. + a low power socket on the side of the Power Board and the other into the 12V + socket on the servo board. 8. Connect the Servo Board to the Pi by way of another micro-USB cable; the USB A (rectangle) end goes into any USB socket on the Pi or connected via the USB hub, the micro-USB end goes into the Servo Board. From c086f1c2bd805e91654aeecfa59e3faf81a06626 Mon Sep 17 00:00:00 2001 From: nmalky Date: Tue, 13 Aug 2019 15:47:00 +0100 Subject: [PATCH 08/19] Add image for camcons Work in progress --- docs/source/tutorials/connecting-your-kit.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/source/tutorials/connecting-your-kit.rst b/docs/source/tutorials/connecting-your-kit.rst index 36f446b8..cfa8ca6f 100644 --- a/docs/source/tutorials/connecting-your-kit.rst +++ b/docs/source/tutorials/connecting-your-kit.rst @@ -26,6 +26,13 @@ Connectors and cables .. Hint:: *CamCons* are the `green connectors `__ used for power wiring within our kit. + +.. figure:: /tutorials/kit-assembly.files/camcons.png + :alt: A CamCon connector + :scale: 75% + + A CamCon connector https://uk.farnell.com/-/ctb92he-2/-/dp/1717047 + Peripherals ----------- From 76281da1486f465354cb10e58f9da9c3d70fa62f Mon Sep 17 00:00:00 2001 From: nmalky Date: Tue, 13 Aug 2019 16:08:04 +0100 Subject: [PATCH 09/19] Try and fix image link idk if this works, preview doesn't seem to --- docs/source/tutorials/connecting-your-kit.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/tutorials/connecting-your-kit.rst b/docs/source/tutorials/connecting-your-kit.rst index cfa8ca6f..f60a3812 100644 --- a/docs/source/tutorials/connecting-your-kit.rst +++ b/docs/source/tutorials/connecting-your-kit.rst @@ -27,7 +27,7 @@ Connectors and cables .. Hint:: *CamCons* are the `green connectors `__ used for power wiring within our kit. -.. figure:: /tutorials/kit-assembly.files/camcons.png +.. figure:: /_static/tutorials/connecting-your-kit/camcon-connector.jpg :alt: A CamCon connector :scale: 75% From ee5acd6c734b18326ec2e8225866d4e400583694 Mon Sep 17 00:00:00 2001 From: Kier Davis Date: Tue, 13 Aug 2019 19:16:50 +0100 Subject: [PATCH 10/19] Put camcon image inside hint box Co-authored-by: nmalky --- docs/source/tutorials/connecting-your-kit.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/source/tutorials/connecting-your-kit.rst b/docs/source/tutorials/connecting-your-kit.rst index f60a3812..e5685f1e 100644 --- a/docs/source/tutorials/connecting-your-kit.rst +++ b/docs/source/tutorials/connecting-your-kit.rst @@ -25,13 +25,13 @@ Connectors and cables - Wire .. Hint:: *CamCons* are the `green connectors `__ - used for power wiring within our kit. - -.. figure:: /_static/tutorials/connecting-your-kit/camcon-connector.jpg - :alt: A CamCon connector - :scale: 75% - - A CamCon connector https://uk.farnell.com/-/ctb92he-2/-/dp/1717047 + used for power wiring within our kit. + + .. figure:: /_static/tutorials/connecting-your-kit/camcon-connector.jpg + :alt: A CamCon connector + :scale: 50% + + A CamCon connector (`more information `__). Peripherals From f2da381be0366690bcc9629644c190c0f73b0216 Mon Sep 17 00:00:00 2001 From: Dan Trickey Date: Thu, 13 Feb 2020 15:33:37 +0000 Subject: [PATCH 11/19] Fix rst formatting issues --- docs/source/tutorials/connecting-your-kit.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/tutorials/connecting-your-kit.rst b/docs/source/tutorials/connecting-your-kit.rst index e5685f1e..fc8306ea 100644 --- a/docs/source/tutorials/connecting-your-kit.rst +++ b/docs/source/tutorials/connecting-your-kit.rst @@ -110,7 +110,7 @@ how to connect things up. You'll be cutting your own wires here! CamCons onto the opposite ends of a pair of wires, ensuring that positive connects to positive and ground to ground, and then plugging one end into a low power socket on the side of the Power Board and the other into the 12V - socket on the servo board. + socket on the servo board. 8. Connect the Servo Board to the Pi by way of another micro-USB cable; the USB A (rectangle) end goes into any USB socket on the Pi or connected via the USB hub, the micro-USB end goes into the Servo Board. From 6d9eb7f9e4b70effbb6c20a299fe70d1a7ad63a1 Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Sat, 15 Jul 2023 14:03:58 +0100 Subject: [PATCH 12/19] Add a dedicated docs page on camcons They're obscure enough that having their own page probably makes sense. --- docs/kit/camcons.md | 19 +++++++++++++++++++ docs/tutorials/connecting-your-kit.md | 4 +--- 2 files changed, 20 insertions(+), 3 deletions(-) create mode 100644 docs/kit/camcons.md diff --git a/docs/kit/camcons.md b/docs/kit/camcons.md new file mode 100644 index 00000000..7a9164b6 --- /dev/null +++ b/docs/kit/camcons.md @@ -0,0 +1,19 @@ +--- +title: Camcons +--- + +[CamCons](https://uk.farnell.com/-/ctb92he-2/-/dp/1717047) are the green connectors used for power wiring within our kit. + +![Board Diagram](../assets/img/assembly/camcons.png) + +Our kit uses 3 different sizes of CamCon: + +- 3.81mm: Used to power the [Pi](./pi.md) +- 5mm: Used to connect motors to the [Motor Board](./motor-board.md) +- 7.5mm: Used to power other boards off the [Power Board](./power-board.md) + +CamCons are keyed such that they can only be inserted one way, and only the correct size will work. + +Stripped wire should be inserted into the back of the CamCon, with as little bare wire exposed as possible. To secure the wire in place, tighten the corresponding screw. +!!! warning + Take care in ensuring you connect the correct polarity to the board. Swapping the wires may not work as expected and can damage the boards. diff --git a/docs/tutorials/connecting-your-kit.md b/docs/tutorials/connecting-your-kit.md index 560b4508..251f8308 100644 --- a/docs/tutorials/connecting-your-kit.md +++ b/docs/tutorials/connecting-your-kit.md @@ -22,9 +22,7 @@ - Any other colour of wire !!! tip - *CamCons* are the green connectors used for power wiring within our kit. - - ![](../assets/img/assembly/camcons.png){ width="50%" } + [CamCons](../kit/camcons.md) are the green connectors used for power wiring within our kit. ## Peripherals From fa1c54114d07e158c1643475f6d7a40f73ae6e6d Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Sat, 15 Jul 2023 14:06:13 +0100 Subject: [PATCH 13/19] Move arduino power warning to important notes This makes sure the numbering flows correctly --- docs/tutorials/connecting-your-kit.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/tutorials/connecting-your-kit.md b/docs/tutorials/connecting-your-kit.md index 251f8308..f44331c6 100644 --- a/docs/tutorials/connecting-your-kit.md +++ b/docs/tutorials/connecting-your-kit.md @@ -64,6 +64,10 @@ You will need to fetch any other needed tools/supplies yourself. power (say 12V or 5V), *black* for wires connected to ground (0V) and *any other colour* for motors. +- Please don't connect the Arduino to the Raspberry Pi via the + USB Hub. If the Arduino is not connected *directly* to the Pi, you may + have issues with getting enough power to it. + ## How it all fits together The first step of your robot is assembly! Here we'll guide you step-by-step on @@ -88,12 +92,6 @@ how to connect things up. You'll be cutting your own wires here! end goes into the Motor Board. 6. Connect the Arduino to the Pi by way of the USB-A (rectangle) to USB-B (square-like) cable. - -!!! warning - Please don't connect the Arduino to the Raspberry Pi via the - USB Hub. If the Arduino is not connected *directly* to the Pi, you may - have issues with getting enough power to it. - 7. Connect the Servo Board to the Power Board by screwing the two 7.5mm (large) CamCons onto the opposite ends of a pair of wires, ensuring that positive connects to positive and ground to ground, and then plugging one end into From 606794df454593be8cf84235ef8e1348135639ab Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Sat, 15 Jul 2023 14:10:55 +0100 Subject: [PATCH 14/19] Add "CamCons" to spelling file --- .spelling | 1 + 1 file changed, 1 insertion(+) diff --git a/.spelling b/.spelling index c899cddb..f628b151 100644 --- a/.spelling +++ b/.spelling @@ -2,6 +2,7 @@ # # Keep each section alphabetically sorted. BIDMAS +CamCons Datacamp GPIO Programiz From c34e552f8025e665b127e617eb69240286d7e1ba Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Sun, 16 Jul 2023 21:55:55 +0100 Subject: [PATCH 15/19] Remove need to connect Arduino direct to Pi Co-authored-by: Will Barber --- docs/tutorials/connecting-your-kit.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/tutorials/connecting-your-kit.md b/docs/tutorials/connecting-your-kit.md index f44331c6..35683937 100644 --- a/docs/tutorials/connecting-your-kit.md +++ b/docs/tutorials/connecting-your-kit.md @@ -64,9 +64,6 @@ You will need to fetch any other needed tools/supplies yourself. power (say 12V or 5V), *black* for wires connected to ground (0V) and *any other colour* for motors. -- Please don't connect the Arduino to the Raspberry Pi via the - USB Hub. If the Arduino is not connected *directly* to the Pi, you may - have issues with getting enough power to it. ## How it all fits together From ad0059437afc354a8f3d5c57949e14935a81e27c Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Sun, 16 Jul 2023 21:56:11 +0100 Subject: [PATCH 16/19] Fix casing on CamCons page title Co-authored-by: Will Barber --- docs/kit/camcons.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/kit/camcons.md b/docs/kit/camcons.md index 7a9164b6..25160b0f 100644 --- a/docs/kit/camcons.md +++ b/docs/kit/camcons.md @@ -1,5 +1,5 @@ --- -title: Camcons +title: CamCons --- [CamCons](https://uk.farnell.com/-/ctb92he-2/-/dp/1717047) are the green connectors used for power wiring within our kit. From 1604058f0c2a36a0a378db8c17e8ffbde48bb76d Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Mon, 24 Jul 2023 22:51:01 +0100 Subject: [PATCH 17/19] Add kit assembly diagram --- docs/assets/img/assembly/kit-assembly.svg | 1997 +++++++++++++++++++++ docs/tutorials/connecting-your-kit.md | 2 + 2 files changed, 1999 insertions(+) create mode 100644 docs/assets/img/assembly/kit-assembly.svg diff --git a/docs/assets/img/assembly/kit-assembly.svg b/docs/assets/img/assembly/kit-assembly.svg new file mode 100644 index 00000000..a0b05df6 --- /dev/null +++ b/docs/assets/img/assembly/kit-assembly.svg @@ -0,0 +1,1997 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + USB + HUB + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + BATTERY + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Power SwitchLoop + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ON + | + OFF + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + START + + + + + + + + + + + + + + + + + H0 + L0 + L1 + H1 + L3 + L2 + POWERBOARD + + + + + + + + + + + + + + + + + + + + + + + + + RASPBERRY PI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + MOTORBOARD + + + + + + + + + + + + + + + + + + + + + + + + + + + + SERVOBOARD + + + + + + + + + + Leave Empty forCompetition USB + + ONLY USEDFOR CHARGING + + + + + + + + + Code USB Stick + + + + + + Not Pictured:Arduino + + + diff --git a/docs/tutorials/connecting-your-kit.md b/docs/tutorials/connecting-your-kit.md index 35683937..f0cf7548 100644 --- a/docs/tutorials/connecting-your-kit.md +++ b/docs/tutorials/connecting-your-kit.md @@ -67,6 +67,8 @@ You will need to fetch any other needed tools/supplies yourself. ## How it all fits together +![An assembled kit](../assets/img/assembly/kit-assembly.svg) + The first step of your robot is assembly! Here we'll guide you step-by-step on how to connect things up. You'll be cutting your own wires here! From fc67786d502891c21a801c04710fa7d0ecb9898a Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Wed, 2 Aug 2023 11:03:02 +0100 Subject: [PATCH 18/19] Add tip about CamCon naming --- docs/kit/camcons.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/kit/camcons.md b/docs/kit/camcons.md index 25160b0f..bbdda1ef 100644 --- a/docs/kit/camcons.md +++ b/docs/kit/camcons.md @@ -4,7 +4,10 @@ title: CamCons [CamCons](https://uk.farnell.com/-/ctb92he-2/-/dp/1717047) are the green connectors used for power wiring within our kit. -![Board Diagram](../assets/img/assembly/camcons.png) +!!! tip + The "Con" in "CamCon" means "Connector", so they're not "CamCon Connectors". + +![CamCons](../assets/img/assembly/camcons.png) Our kit uses 3 different sizes of CamCon: @@ -15,5 +18,6 @@ Our kit uses 3 different sizes of CamCon: CamCons are keyed such that they can only be inserted one way, and only the correct size will work. Stripped wire should be inserted into the back of the CamCon, with as little bare wire exposed as possible. To secure the wire in place, tighten the corresponding screw. + !!! warning Take care in ensuring you connect the correct polarity to the board. Swapping the wires may not work as expected and can damage the boards. From ac00f7503158e6112baebb0b38ff035e504b6fed Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Sat, 5 Aug 2023 19:26:28 +0100 Subject: [PATCH 19/19] Fix polarity and location of Pi power connector --- docs/assets/img/assembly/kit-assembly.svg | 91 ++++++++++++----------- 1 file changed, 46 insertions(+), 45 deletions(-) diff --git a/docs/assets/img/assembly/kit-assembly.svg b/docs/assets/img/assembly/kit-assembly.svg index a0b05df6..cb874f4e 100644 --- a/docs/assets/img/assembly/kit-assembly.svg +++ b/docs/assets/img/assembly/kit-assembly.svg @@ -144,11 +144,11 @@ id="path5108" /> Power SwitchLoop + transform="translate(-73.095093,-31.940163)"> + style="overflow:hidden;fill:none;fill-rule:evenodd;stroke:none;stroke-width:1483.04;stroke-linecap:square;stroke-miterlimit:4;stroke-dasharray:none" + transform="matrix(6.6661187e-5,-0.0067941,0.00537659,6.7880121e-5,140390.42,32992.448)"> + transform="matrix(3.3355449e-5,-0.00999994,0.00999994,3.3355449e-5,140481.03,33268.739)"> - - - - - - - + style="overflow:hidden;opacity:1;vector-effect:none;fill:#c0c0c0;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:665.951;stroke-linecap:round;stroke-linejoin:bevel;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" /> + style="overflow:hidden;opacity:1;vector-effect:none;fill:#c0c0c0;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:665.951;stroke-linecap:round;stroke-linejoin:bevel;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" /> + style="fill:#ffffff;fill-opacity:1;stroke:#303030;stroke-width:1483.04;stroke-linecap:butt;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" /> + + + + + + + Code USB Stick Arduino