moduland / orangetool

📚 Control Functions For Single-Board Computers

---

Table of contents

• Overview
• Installation
• Usage
  • IP Functions
  • RAM Functions
  • Storage Functions
  • Display Functions
  • System Functions
• Issues & Bug Reports
• Supported Device List
• Dependencies
• Contribution
• Cite
• Authors
• License
• Donate
• Changelog
• Code of Conduct

Overview

Control functions for Single-Board computers

Tested on Lubuntu

Open Hub
PyPI Counter
Github Stars

Branch	master	dev
Travis

Code Quality

---

By Moduland Co

Installation

Source Code

• Download Version 0.50 or Latest Source
• pip3 install -r requirements.txt or pip install -r requirements.txt (Need root access)
• python3 setup.py install or python setup.py install

PyPI

• Check Python Packaging User Guide
• pip3 install orangetool==0.50 or pip install orangetool==0.50 (Need root access)

Conda

• Check Conda Managing Package
• conda install -c sepandhaghighi orangetool (Need root access)

Easy install

• Run easy_install --upgrade orangetool (Need root access)

Usage

IP Functions

import orangetool

#1- local_ip

local_ip=orangetool.local_ip() # this function return local ip of board as string

#2- global_ip

global_ip=orangetool.global_ip() # this function return global ip of board as string

#3- internet 

status=orangetool.internet() #this function check internet connection and return True if internet connection is stable

#4- ping

ip_status=orangetool.ping(ip_address) #this function check ip and return True if this ip is available in network and False otherwise

#5- set_ip

orangetool.set_ip("192.168.1.46","eth0")  #this function set static ip for system

#6- mac

mac_dic=orangetool.mac() # return dict of all system net devices mac addresses

#7- network_enable

status=network_enable("eth0") # enable network device

#8- network_disable

status=network_disable("eth0") # disable network device

RAM Functions

 
#1- total ram

ram=orangetool.ram_total() #this function return total ram of the board

#2- free ram

ram=orangetool.ram_free() # this function return how much ram is available in the board

#3- ram percentage

ram=orangetool.ram_percent() # this function return used ram percentage

#4- used percentage

ram=orangetool.ram_used() # this function return used ram 

#5- freeup

orangetool.freeup() # To free pagecache, dentries and inodes and return freeuped amount

Storage Functions

#1- mount_status

mount_details=orangetool.mount_status("sda1") # This function return mount addresses of input device

#2- storage_status

mount_details=orangetool.storage_status() # This function return all of the inserted storage and their status

#3- unmount

orangetool.unmount("/mnt/usb1") # This function unmount input device

#4- unmount_all


orangetool.unmount_all() #This function unmount all of the mounted devices

#5- mount

orangetool.mount("sda1","/mnt/usb1") # This function mount input device in input addresses

#6- usb_on

orangetool.usb_on() # This function enable USB

#7- usb_off

orangetool.usb_off() # This function disable USB

Display Functions

#1- hdmi_on

orangetool.hdmi_on() # turn on hdmi port

#2- hdmi_off

orangetool.hdmi_off() # turn off hdmi port

#3- hdmi_size

orangetool.hdmi_size(1280,720) # this function change hdmi display resolution

System Functions

#1- sleep

orangetool.sleep() # put system in sleep mode

#2- hibernate

orangetool.hibernate() # put system in hibernate mode

#3- halt

orangetool.halt() # poweroff system

#4- restart

orangetool.restart() # restart system

#5- wakeup

orangetool.wakeup(day=1,hour=0,minute=1,sync=True) # set rtc wakeuptime

#6- get_temp

temp=orangetool.get_temp() # this function return cpu temperature as string

#7- uptime

time=orangetool.uptime() # this function return uptime of system

#8- idletime

time=orangetool.idletime() # this function return idle of system ( all cores)


#9- version

orangetool.version() # return orangetool version for test

#10- check_update

orangetool.check_update() # Return True if new version is available

• All of the functions in error state return Error String
• local_ip and global_ip originally are available in ipz package Link
• RAM functions in this version need psutil package
• Running set_ip function remotely will freeze your terminal so it's better to set restart parameter to True
• Running halt,restart,hibernate & sleep functions remotely will freeze your terminal
• Some of funtions need root access so it's better to run sudo -s before use this tool

Issues & Bug Reports

Just fill an issue and describe it. We'll check it ASAP! or send an email to [email protected].

Dependencies

master	dev

Cite

If you use orangetool in your research , please cite this ;-)

Sepand Haghighi. 2017. Moduland/Orangetool: Version 0.23. (July 2017). DOI:http://dx.doi.org/10.5281/zenodo.829797

Donate to our project

If you feel like our project is important can you please support us? Our project is not and is never going to be working for profit. We need the money just so we can continue doing what we do.

Bitcoin :

1XGr9qbZjBpUQJJSB6WtgBQbDTgrhPLPA

Payping (For Iranian citizens) :

License

orangetool's Issues

Add sync parameter to wakeup function

Add sync parameter to wakeup function

New SBCs - orangetool.full_status_report()

I have an Odroid. I'll like to test orangetool and copy/paste something back that's useful to the project. is there a dump() or unknown_sbc() or full_report() or debug() invocation that'd be informative?

USB control

Description

Add functions to control USB port

Network control

Description

Add functions to enable and disable network

Add __main__ file

Description

Add __main__ file

Change MAC address

Description

Add function to change MAC address