Can I customize Farm OS web and mobile

Development
1

Dear FarmOS Technical Team

Greetings! thank you for FarmOS open source.

We are a start-up in the Agri space based out in Bangaluru, India.
I just started checking out FarmOS documentation and would like to try it out for our farmers.

We have a few queries on mainly customizing the web and mobile app and need your help.

  1. Can we integrate FarmOS UI into our web app such that the FarmOS screens open up in our app?
    b. How can we integrate the field kit mobile app into our app?

  2. Can we integrate entities like logs? E.g. we will be generating weekly activities outside of FarmOS and will need to sync them to FarmOS logs so farmers can view them.

  3. Can we integrate our IoT data into FarmOS?

  4. Is there a technical document that I can refer?

  5. I have been trying to install FarmOS on windows. I got lost as to where to start with as I could not find step by step guide. I am new to Drupal. I will study further.

Thank you!!

1 Like
2

Hi @niravrambhia - welcome to the farmOS community! Glad to hear that farmOS might be useful to your farmers!

  1. Can we integrate FarmOS UI into our web app such that the FarmOS screens open up in our app?
    b. How can we integrate the field kit mobile app into our app?

Both farmOS and Field Kit are web applications. farmOS is built on Drupal, and Field Kit is a custom Vue.js app. They are designed to be used standalone, but you may be able to “integrate” them into your app - depending on what you have in mind.

It is possible to write custom modules for both farmOS and (soon) Field Kit, which allows you to add additional functionality to them. This might be worth exploring.

A word of advice: we are in the middle of a big upgrade (farmOS 2.x) which will change a lot of things. I would highly recommend waiting until farmOS 2.0.0 is released before investing too much time or development into custom features - because they will need to be rewritten.

We are starting to document a lot of the 2.x possibilities here: https://docs.farmOS.org - which will become the official documentation when farmOS 2.x is released.

  1. Can we integrate entities like logs? E.g. we will be generating weekly activities outside of FarmOS and will need to sync them to FarmOS logs so farmers can view them.

farmOS has a REST API for creating/updating records via HTTP+JSON requests. Here is the documentation for the 1.x API: API | farmOS

The 2.x API will have similar capabilities, but will be based on JSON:API: https://jsonapi.org/

  1. Can we integrate our IoT data into FarmOS?

farmOS has a concept of “Sensor Assets” which can be used to represent sensors and other devices deployed on the farm. These sensors can accept data sent to them via their HTTP API. Here is the documentation for this in 1.x: Sensors - farmOS.org

This will work similarly in 2.x - but it will also be possible to create your own integrations with other types of sensors.

  1. Is there a technical document that I can refer?

Documentation for the current version is available on https://farmOS.org.

Documentation for 2.x is being written here: https://docs.farmOS.org

  1. I have been trying to install FarmOS on windows. I got lost as to where to start with as I could not find step by step guide. I am new to Drupal. I will study further.

As far as I know farmOS can be installed on Windows - although I have never tried it myself, and we do not “officially” support it. But I do recall some people in the forum using Windows, so if you have issues I would recommend starting a dedicated forum topic about it. Generally speaking this would be a Drupal question, not specific to farmOS, so you may also have more luck in a more general Drupal support forum or chat.

Hope that helps! Good luck!

3

Thank you! Will go by your advice.

1 Like