diff --git a/docs/assembly_guide.md b/docs/assembly_guide.md index d8b7c9c..3878d71 100644 --- a/docs/assembly_guide.md +++ b/docs/assembly_guide.md @@ -303,3 +303,6 @@ Congratulations on a job well done. You can have some rest, get a tea and some b ![Step35](assembly_guide/render/step35.webp) You can now plug the machine in and test it. If you have choose the Expert's path, now is a good time to [finish setting up your machine](expert_setup.md). + +## Step 34: Read the getting started guide +[A guide to get started with your machine use is available!](getting_started.md) \ No newline at end of file diff --git a/docs/getting_started.md b/docs/getting_started.md new file mode 100644 index 0000000..47baec6 --- /dev/null +++ b/docs/getting_started.md @@ -0,0 +1,29 @@ +# Getting started with using the machine +Congratulations! You have finished assembling your machine, now is the time to test it and learn how to use it! + + +## How to connect to and control the machine +On powering up, your PlanktoScope will create its own isolated WiFi network. It should appear on the list of available wifi networks about two minutes after the first startup. +![network list](getting_started/wifi.webp) + +As you can see, its name will be similar to `PlanktoScope-Baba*****_*****`. This name is unique to your machine and is linked to the serial number of the Raspberry CPU. You can connect to this network now. + +Once connected, you will not have acces to the Internet, only to the PlanktoScope interface. You can access the page at [http://planktoscope.local:1880/ui](http://planktoscope.local:1880/ui) from your favorite web browser. + +!!! tip + You are able to configure your machine to connect to another network if you want in the [Wifi settings page](ui_guide.md#wifi). If you do this, your machine will be accessible to anybody connected to this network. Please keep in mind your organisation security policies before doing this. + +From there, you can have a look at the [UI guide](ui_guide.md) to get a handle on how it works. + + +## How to image plankton +Before doing an acquisition, you will need to collect targets. There are several ways to do this, and you probably already have a source nearby (in a culture if you are working in a lab). + +However, if you have access to a body of water (even a tiny lake or river is enough), you can build yourself a plankton net to collect a sample. Once the sample is collected, either pump it with a syringe that you connect to the machine, or dip one of the silicone tube inside the sample tube you have. + +You can then do an acquisition run. **This is the best way to learn about the machine and this process!** + +!!! warning + After doing an acquisition, the machine should be cleaned, especially in the fluidic part. One good way to do this is to first flush the machine with clear water (distilled if possible). You can then push through a 5-10% bleach solution, or some alcohol. + + If needed you can also clean the outside of the objective lens with a soft cloth. You can do the same on the flow cell if there are traces of finger on it too. \ No newline at end of file diff --git a/docs/getting_started/wifi.webp b/docs/getting_started/wifi.webp new file mode 100644 index 0000000..2723e5d Binary files /dev/null and b/docs/getting_started/wifi.webp differ diff --git a/docs/ui_guide.md b/docs/ui_guide.md index c1780a1..952757d 100644 --- a/docs/ui_guide.md +++ b/docs/ui_guide.md @@ -111,6 +111,24 @@ Before purging the local data, make sure your data has been backed up at least t For this machine, this means creating two copies on two different USB drives of the data before purging it from the device. Also, you should backup your device after each acquisition. +## Wifi + +![Administration](ui_guide/wifi.webp) + +This page will give you information about the network the PlanktoScope is connected to. It will also allows you to connect your machine to a new WiFi network. + +Start by doing a network scan by clicking on the `Scan` button. The list will be populated with detected networks after a few seconds. You can then choose one of them, enter its password and click on `Add the network` to connect to it. The wifi network of the PlanktoScope will disappear after a few seconds, so **you will need to connect back to the same network you just put the machine on**. + +Finally, if you are not located in France, please update the Country code in the field below. This will ensure the PlanktoScope complies with local Wifi regulations (such as maximum emitted power, duty cycle and such). + +Clicking on the button `Reset wifi networks` will erase ALL networks saved previously by the machine. If you do this, it will disconnect immediately from any network it's connected to, and will put up its own network. + +!!! info + For now, only WPA/WPA2 Personnal security system is supported. If you need another security system supported, get in touch with us. + +!!! warning + Please be mindful about the security policies of your organisation before connecting your device to a network (either through Wifi or with an Ethernet cable). A lot of research institutions don't allow devices not controlled by them to be connected to their network without first going on an approved list with a least a basic security checkup. + ## Administration diff --git a/mkdocs.yml b/mkdocs.yml index d71832d..316e982 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,6 +7,7 @@ nav: - Assembly: - Assembly guide: assembly_guide.md - Usage: + - Getting started: getting_started.md - User Interface: ui_guide.md - Collection devices: collection_devices.md - Hardware: