Skip to content

Commit

Permalink
Merge pull request #142 from mrodriguez3313/main
Browse files Browse the repository at this point in the history
Added to Fula Docs
  • Loading branch information
ehsan6sha authored Mar 20, 2024
2 parents 5bdd755 + 322e3c2 commit c9b6907
Show file tree
Hide file tree
Showing 8 changed files with 72 additions and 43 deletions.
23 changes: 21 additions & 2 deletions docs/release/functionyard/fxblox-app.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: FxBlox App
title: FxBlox App Setup
id: fxblox-app
---

Expand All @@ -10,7 +10,7 @@ id: fxblox-app
If you have setup FxBlox **before** official testnet launch, you will be required to format drive to clear out old/incompatible chain data. You can **format the drive after completing setup** and by **click and holding anywhere on the Hard Drive info box** until the pop-up option appears. See more [details here](./fxblox-app.md/#format-drive)
:::
1. **Download the App**:
- For Android: [FxBlox on Google Play (v1.5.5+)](https://play.google.com/store/apps/details?id=land.fx.blox).
- For Android: [FxBlox on Google Play (v1.6.2+)](https://play.google.com/store/apps/details?id=land.fx.blox).
- For iOS: Available soon on the App Store.
2. **Metamask Wallet**: Ensure you have a [Metamask wallet](https://play.google.com/store/apps/details?id=io.metamask) for setting up your identity.

Expand Down Expand Up @@ -40,6 +40,25 @@ If you have setup FxBlox **before** official testnet launch, you will be require
- **If Metamask doesn't redirect after signing transaction**: Manually go back to the FxBlox app.
- **App issues with Metamask**: On some phones, if you cannot get the "Connect" and "sign" prompts in Metamask, you may need to put both the Metamask app and Blox app in Unrestricted mode from the "Battery Optimization". Go to: `Settings` > `Apps` > `FxBlox` > `Battery` / `App Battery` > Choose `Unrestricted`. Do the same for the Metamask app. After the setup, you can return it back to the default of `Optimized`

## Add Multiple FxBlox's

As of Android/iOS app version 1.6.2, there is not an easy way to add more than one blox to your account. Follow these additional steps if you would like to connect more than one blox:

1. If not already done, complete setup of your first Blox.
2. Verify Blox is listed as `Authorized` under `Settings`->`Blox Discovery`. If not, restart your Blox by unplug/plug-ing it back in.
3. `Log Out` of your account by going to `Settings` -> `Log Out`.
4. Proceed and complete set-up of your next FxBlox.
5. Repeat steps 2-4 for all the FxBloxes you have, except for the last one.
6. When you've finally added the last FxBlox, go to `Settings` -> `Blox Discovery`.
7. All FxBloxes should say `Authorized`, so select them and click `Add selected blox(s)`.
8. Verify you can see all of them by going to `Blox` tab and swiping left/right between them.

:::info
As you can see the functionality is there, but priotization of an easier way to add them is scheduled for after testnet launch.

**Our apps are open-source and built in React Native for cross-platform support. So if you would like to [contribute to the project](https://github.com/functionland/fx-components), that would be greatly appreciated!**
:::

## Format Drive

If you were eager to test out nightly releases on your own, you may have trouble joining the official launch of the testnet. This is because the blocks from the temporary chains are incompatible with the official testnet blocks. To fix this, you need to erase all previous blocks, easiest way is to format the drive.
Expand Down
29 changes: 14 additions & 15 deletions docs/release/functionyard/fxblox-hardware.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: FxBlox Hardware
title: FxBlox Firmware Upgrade Guide
id: fxblox-hardware
---

Expand Down Expand Up @@ -33,7 +33,20 @@ Before starting, make sure that your USB stick is **32GB or smaller**. Anything
1. Ensure your FxBlox is turned off.
2. Connect the USB drive to the top USB port of the FxBlox. (Only the top port is designed for updates)
3. Turn on your FxBlox. The LED will display <font color="green">green</font>, <font color="blue">blue</font>, and then yellow, indicating the update process.
<div class="text--center">
<video width="400" height="400" controls>
<source src="https://github.com/functionland/rk1-image/assets/6176518/06ddf8ed-61a0-4031-b48d-77f7f7ba79eb" type="video/mp4" />
Your browser does not support the video tag.
</video>
</div>

4. After about 15 minutes, the LED blinks <font color="green">green</font> and <font color="blue">blue</font>. Remove the USB drive.
<div class="text--center">
<video width="400" height="400" controls>
<source src="https://github.com/functionland/rk1-image/assets/6176518/71d42e46-1cc8-4ab7-b573-a11eeaea3289" type="video/mp4" />
Your browser does not support the video tag.
</video>
</div>
5. Restart the FxBlox by unplugging and plugging back the power.

### Step 4: Post-Update
Expand All @@ -46,17 +59,3 @@ Before starting, make sure that your USB stick is **32GB or smaller**. Anything
:::info
Future firmware updates will be over the air, eliminating the need for manual updates.
:::

## Video Demo of the update steps:

### After attaching the USB:
<video width="320" height="240" controls>
<source src="https://github.com/functionland/rk1-image/assets/6176518/06ddf8ed-61a0-4031-b48d-77f7f7ba79eb" type="video/mp4" />
Your browser does not support the video tag.
</video>

### After about 15 minutes:
<video width="320" height="240" controls>
<source src="https://github.com/functionland/rk1-image/assets/6176518/71d42e46-1cc8-4ab7-b573-a11eeaea3289" type="video/mp4" />
Your browser does not support the video tag.
</video>
2 changes: 1 addition & 1 deletion docs/release/functionyard/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ id: index

# Functionyard Testnet Launch Guide

This comprehensive guide is designed to assist you in preparing your FxBlox for the testnet launch. The testnet is called "Functionyard" and the token is "BORG".
This comprehensive guide is designed to assist in preparing a FxBlox owner for the testnet launch. The testnet is called "Functionyard" and the token is "BORG".
23 changes: 21 additions & 2 deletions docs/release/functionyard/join.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,29 @@ id: join

1. In the `FxBlox` App, go to the `Users` Page and click `Join Testnet`
<div class="text--center">
<img src="/img/fxyard-network/join-testnet.png" style={{width: 500}}/>
<img src="/img/fxyard-network/join-testnet.png" style={{width: 400}}/>
</div>
- Or you can manually visit the testnet page at [Functionyard Testnet](https://fund.functionyard.fula.network) and enter your Indiegogo campaign order details and account id from the Blox app.
- If the `Account` and `Join` buttons are greyed out, it means the blox is still syncing the chain data. It may take a few minutes to up to a day depending on the speed of the attached USB and internet speed. We will add a more visual indicator of this in future releases.
2. In the FxBlox app, go to `Settings > Pools`. Join a pool nearest to your city. Choose the one closest to you from the list. Please note, that if you choose a pool that is far from you, the request will automatically rejected by the system.

:::warning
If you have setup FxBlox **before** official testnet launch, you will be required to format drive to clear out old/incompatible chain data. You can **format the drive after completing setup** and by **click and holding anywhere on the Hard Drive info box** until the pop-up option appears. See more [details here](./fxblox-app.md/#format-drive)
:::

2. In the FxBlox app, go to `Settings > Pools`. Join a pool nearest to your city. Choose the one closest to you from the list. Please note, that if you choose a pool that is far from you, the request will automatically rejected by the system.

<div class="text--center">
<img src="/img/fxyard-network/join-btn.png" style={{width: 400}}/>
</div>

3. Wait for approval from 5 pool members (may take up to 24 hours right now).

<div class="text--center">
<img src="/img/fxyard-network/cancel-btn.png" style={{width: 400}}/>
</div>

4. Once approved, the pool button changes to "Leave". You can now start storing and earning.

<div class="text--center">
<img src="/img/fxyard-network/leave-btn.png" style={{width: 400}}/>
</div>
38 changes: 15 additions & 23 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,21 @@ const sidebars = {
type: 'doc',
label: 'Welcome',
id: 'welcome',
},
{
type:'category',
label:'Functionyard Testnet',
link: {
type:'doc',
id:'release/functionyard/index',
},
items:[
'release/functionyard/fxblox-hardware',
'release/functionyard/fxblox-app',
'release/functionyard/join',
'release/functionyard/metamask',
'release/functionyard/dapps',
]
},
{
type: 'category',
Expand Down Expand Up @@ -190,29 +205,6 @@ const sidebars = {
},

],
functiontard: [
{
type: 'category',
label: 'Functionyard Testnet',
items: [
{
type:'category',
label:'Functionyard Network',
link: {
type:'doc',
id:'release/functionyard/index',
},
items:[
'release/functionyard/fxblox-hardware',
'release/functionyard/fxblox-app',
'release/functionyard/join',
'release/functionyard/metamask',
'release/functionyard/dapps',
]
}
]
}
]
};

module.exports = sidebars;
Binary file added static/img/fxyard-network/cancel-btn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/fxyard-network/join-btn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/fxyard-network/leave-btn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c9b6907

Please sign in to comment.