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

updated website analytics and fixed a couple of typos #325

Merged
merged 6 commits into from
Aug 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions website/docs/amiga_quick_start/amiga-quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ While operating the Amiga:
- Do not stand in front of the Amiga
- Have Amiga on flat surface
- Have both batteries inserted and powered

:::

## Starting the Amiga
Expand Down Expand Up @@ -73,6 +74,7 @@ and anytime you replace the pendant.
:::caution

- Before testing pendant, you should press physical ESTOP so the Amiga does not drive while testing.

:::

![ezgif com-gif-maker 2 (1)](https://user-images.githubusercontent.com/64480560/206317768-42edeab6-8fea-4c7d-95ae-a3ff3d9e62f1.gif)
Expand Down
4 changes: 2 additions & 2 deletions website/docs/farm-tools/three-point.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,5 +124,5 @@ immediately.

13. Your result should represent the image below.
<img src="https://github.com/farm-ng/amiga-dev-kit/assets/64480560/b483ace5-9836-43b0-9b5e-8597bf8e8fc6"
width="500"
height="200" />
width="300"
height="400" />
3 changes: 1 addition & 2 deletions website/docs/hardware/electronics.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@ placed inside the side panel. Each motor have the following specs:
|---|---|
|Rated power|250 W|
|Operational Voltage|36 ~ 43 VDC|
|Reduction ratio| 1:11|
|Torque|42 N.m (21 Lb.ft)|
|Reduction ratio| 1:30|

Each motor requires its own motor controller and, despite sharing the same hardware, they have
the tires mounted differently. Make sure your motor is adequate to each side of your Amiga when
Expand Down
2 changes: 1 addition & 1 deletion website/docs/hardware/mechanics.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ center of gravity, duty cycle, how many turns you are using, etc.

* Note there is a tradeoff here: larger bases are more stable but cause extra effort on the outside
wheels when turning.
* Unless otherwise stated, we recommend 23 lb.ft (310 N.m) of torque on all bolts and nuts in your
* Unless otherwise stated, we recommend 23 lb.ft (31 N.m) of torque on all bolts and nuts in your
Amiga.

## Length (`wheel_track`)
Expand Down
249 changes: 121 additions & 128 deletions website/docs/reference/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,127 @@ id: faq
title: Frequently Asked Questions
---

## General

<details>
<summary>How do I access and develop on the brain?</summary>
<div>
We have a dedicated webpage to help you connect your Amiga.
Check out this <a href="/docs/ssh/">
tutorial</a>
</div>
</details>

<details>
<summary>How do I update the Dashboard Firmware?</summary>
<div>
All latest updates are available online with detailed
instructions that will take you step by step to a successful
update.
<br/><br/>
- You can find more details at: <a href="/docs/dashboard/dashboard-fw">
Dashboard Firmware Updates</a>.
</div>
</details>

<details>
<summary>Who do I get in touch with for errors with the Amiga?</summary>
<div>
To ensure we are continuous improving our software and hardware products, we have several
channels to contact our support team:
<br/>
- The fastest way for general problems is, signing-in, search, and ask questions on our
[Discourse Community](https://discourse.farm-ng.com/).
- For particular cases, send us an email at [email protected].
- For software issues related to our open-sourced libraries, <a href="https://github.com/farm-ng/farm-ng-amiga/issues/new/choose">
create a Bug Report on GitHub</a>.
<br/>
All support cases are subject to our
<a href="https://github.com/farm-ng/farm-ng-amiga/issues/new/choose">Amiga Support Agreement</a>
</div>
</details>

<details>
<summary>What is the voltage level of the amiga pendant and brain?</summary>
<div>
24v power is the voltage for the Brain and the Pendant. The batteries supply 44v (nominal) to the
main power circuit, and the PoE Switch uses a stabilized 48v source powered by 2 DC Converts (step
down and step up schema). For details, see [Base Amiga Electronics](../hardware/electronics.md).
</div>
</details>

<details>
<summary>How do I access the MAC address on Brain?</summary>
<div>
On your Brain main screen, navigate to Seetings > About > Debug Terminal. Click `Show
Keyboard` and type `ifconfig`. Scroll down the results of the command until you find the
`wlan0` section. Your MAC address will be int he line that starts with `ether` and will be
of the form `28:d0:aa:b5:12:ef`. Provide it for your network admin for whitelisting on your
wi-fi network.
</div>
</details>

## CAN bus

<details>
<summary>
What is the baud rate of the CAN bus the Amiga runs on?
</summary>
<div>
The Amiga CAN bus runs at 250 kbps (250,000 bits per second).
<br/><br/>
</div>
</details>

## Brain App Development

<details>
<summary>How can I create a new app for the brain?</summary>
<div>
Custom applications can be created on the brain from
anywhere. We have a detailed tutorial on creating your first
custom app on your Amiga.
<br/><br/>
- You can find more details at: <a href="/docs/brain/brain-apps">
Developing Custom Applications</a>.
</div>
</details>

<details>
<summary>
Why are other apps launching over the app I'm currently using?
</summary>
<div>
**deprecation warning**<br/>
This is out-of-date for brains running `v2.x` Amiga OS software.<br/>
This video only applies to brains running Amiga OS `v1.x` versions.<br/>
**end warning**<br/>
<br/><br/>
If you launch an app with the command line using an <code>entry.sh</code> script,
it is currently possible to have touch interactions with the launcher behind.
This will cause other installed apps to unexpectedly launch over the app you are trying to use.
<br/><br/>
If this is causing you issues,
a simple workaround is to launch a basic, empty app that will block touches from the launcher.
The <a href="https://github.com/farm-ng/amiga-app-template"><code>amiga-app-template</code>
</a> is well suited for this.
<br/><br/>
In your terminal <code>ssh</code>'d in as the <code>amiga</code> user:
<br/><br/>
<code>
cd ~/apps/
</code>
<br/>
<code>
git clone https://github.com/farm-ng/amiga-app-template.git
</code>
<br/><br/>
Then launch the app template by clicking the <code>Amiga App Template</code> AppButton on the launcher
before running your custom app with the <code>entry.sh</code> script.
<br/><br/>
Apps launched by clicking the AppButton should not experience this issue.
</div>
</details>

## Using the REPL

Expand Down Expand Up @@ -126,131 +247,3 @@ title: Frequently Asked Questions
multiple devices.
</div>
</details>

## General

<details>
<summary>How do I access and develop on the brain?</summary>
<div>
We have a dedicated webpage to help you connect your Amiga.
Check out this <a href="/docs/ssh/">
tutorial</a>
</div>
</details>

<details>
<summary>How do I update the Dashboard Firmware?</summary>
<div>
All latest updates are available online with detailed
instructions that will take you step by step to a successful
update.
<br/><br/>
- You can find more details at: <a href="/docs/dashboard/dashboard-fw">
Dashboard Firmware Updates</a>.
</div>
</details>

<details>
<summary>Who do I get in touch with for errors with the Amiga?</summary>
<div>
To ensure we are continuous improving the Amiga, we have made
it easy for you to submit any bug reports you may be having via
the farm-ng-amiga Github.
<br/><br/>
- You can find more details at: <a href="https://github.com/farm-ng/farm-ng-amiga/issues/new/choose">
Create a Bug Report</a>.
</div>
</details>

<details>
<summary>What is the voltage level of the amiga pendant and brain?</summary>
<div>
24v power is the voltage for the brain and pendant. While the PoE Switch is 48v.
<br/><br/>
</div>
</details>

<details>
<summary>How do I connect the Amiga to Cell Phone Hotspot?</summary>
<div>
Depending on your cellular device, instructions can be found in the link below.
<br/><br/>
You can find more details at: <a
href="https://discourse.farm-ng.com/t/connecting-to-the-amiga-cell-phone-hotspot/131">
Connecting to the Amiga - Cell Phone Hotspot</a>.
</div>
</details>

<details>
<summary>How do i access the MAC address on Brain?</summary>
<div>
To learn how to access the MAC address of the Brain's WiFi adapter please visit the link below.
There, the following describes how to retrieve the MAC Address of the Brain WiFi adapter.
<br/><br/>
You can find more details at: <a
href="https://discourse.farm-ng.com/t/wifi-access-the-mac-address/139">
How to access MAC address on Brain</a>.
</div>
</details>

## CAN bus

<details>
<summary>
What is the baud rate of the CAN bus the Amiga runs on?
</summary>
<div>
The Amiga CAN bus runs at 250 kbps (250,000 bits per second).
<br/><br/>
</div>
</details>

## Brain App Development

<details>
<summary>How can I create a new app for the brain?</summary>
<div>
Custom applications can be created on the brain from
anywhere. We have a detailed tutorial on creating your first
custom app on your Amiga.
<br/><br/>
- You can find more details at: <a href="/docs/brain/brain-apps">
Developing Custom Applications</a>.
</div>
</details>

<details>
<summary>
Why are other apps launching over the app I'm currently using?
</summary>
<div>
**deprecation warning**<br/>
This is out-of-date for brains running `v2.x` Amiga OS software.<br/>
This video only applies to brains running Amiga OS `v1.x` versions.<br/>
**end warning**<br/>
<br/><br/>
If you launch an app with the command line using an <code>entry.sh</code> script,
it is currently possible to have touch interactions with the launcher behind.
This will cause other installed apps to unexpectedly launch over the app you are trying to use.
<br/><br/>
If this is causing you issues,
a simple workaround is to launch a basic, empty app that will block touches from the launcher.
The <a href="https://github.com/farm-ng/amiga-app-template"><code>amiga-app-template</code>
</a> is well suited for this.
<br/><br/>
In your terminal <code>ssh</code>'d in as the <code>amiga</code> user:
<br/><br/>
<code>
cd ~/apps/
</code>
<br/>
<code>
git clone https://github.com/farm-ng/amiga-app-template.git
</code>
<br/><br/>
Then launch the app template by clicking the <code>Amiga App Template</code> AppButton on the launcher
before running your custom app with the <code>entry.sh</code> script.
<br/><br/>
Apps launched by clicking the AppButton should not experience this issue.
</div>
</details>
12 changes: 12 additions & 0 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ async function createConfig() {
sidebarPath: require.resolve('./sidebars.js'),
editUrl:
'https://github.com/farm-ng/amiga-dev-kit/tree/main/website/',

},
blog: {
showReadingTime: true,
Expand All @@ -60,6 +61,17 @@ async function createConfig() {
],
],

plugins: [
[
"posthog-docusaurus",
{
apiKey: "phc_tOUxR37cMslYGTJcn699eycJmeuhkHp0lNmLV9kyHkm",
appUrl: "https://us.i.posthog.com", // optional, defaults to "https://us.i.posthog.com"
enableInDevelopment: false, // optional
},
],
],

themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
Expand Down
14 changes: 8 additions & 6 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,21 @@
"write-heading-ids": "docusaurus write-heading-ids"
},
"dependencies": {
"@docusaurus/core": "3.0.0",
"@docusaurus/preset-classic": "3.0.0",
"@docusaurus/theme-mermaid": "3.0.0",
"@mdx-js/react": "3.0.0",
"@docusaurus/core": "^3.4.0",
"@docusaurus/preset-classic": "^3.4.0",
"@docusaurus/theme-mermaid": "^3.4.0",
"@mdx-js/react": "^3.0.1",
"clsx": "^1.2.1",
"mermaid": "^9.1.7",
"posthog-docusaurus": "^2.0.1",
"posthog-js": "^1.154.0",
"prism-react-renderer": "^2.1.0",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.0.0",
"@docusaurus/types": "3.0.0"
"@docusaurus/module-type-aliases": "^3.4.0",
"@docusaurus/types": "^3.4.0"
},
"browserslist": {
"production": [
Expand Down
39 changes: 39 additions & 0 deletions website/src/components/FeedbackButtons.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import React, { useState } from 'react';
import posthog from 'posthog-js';

function FeedbackButtons() {
const [liked, setLiked] = useState(false);
const [disliked, setDisliked] = useState(false);

const handleLikeClick = () => {
setLiked(true);
posthog.capture('page_feedback', {
page: window.location.pathname,
feedback: 'like'
});
};

const handleDislikeClick = () => {
setDisliked(true);
posthog.capture('page_feedback', {
page: window.location.pathname,
feedback: 'dislike'
});
};

return (
<div className="feedback-container">
<h6>Was this page helpful?</h6>
<div className='feedback-buttons'>
<button onClick={handleLikeClick} disabled={liked}>
{liked ? '✔️' : '👍'}
</button>
<button onClick={handleDislikeClick} disabled={disliked}>
{disliked ? '✔️' : '👎'}
</button>
</div>
</div>
);
}

export default FeedbackButtons;
Loading
Loading