class I18n(object):
def __init__(self):
self.lang_params = {}
self.ids_lang = []
self.id_path_dict = {}
self.trans_dict = {}
self.listIds()
self.Preferences = Preferences()
self.id_lang = self.Preferences.get('id_lang', Tools.getSystemLang())
self.changeLang(self.id_lang)
def listIds(self):
language_list_path = Paths.getLanguageList()
self.lang_params = JSONFile(language_list_path).getData()
language_path = Paths.getLanguagePath()
lang_file_paths = glob.glob(language_path + '/*.lang')
lang_file_names = [os.path.basename(p) for p in lang_file_paths]
self.ids_lang += [os.path.splitext(nam)[0] for nam in lang_file_names]
self.id_path_dict.update(dict(zip(self.ids_lang, lang_file_paths)))
self.ids_lang.sort(key=lambda _id: self.lang_params.get(_id)[1])
def changeLang(self, lang_id):
if lang_id in self.id_path_dict:
self.id_lang = lang_id
lang_file_path = self.id_path_dict[lang_id]
lang_file = LanguageFile(lang_file_path)
self.trans_dict = lang_file.getTransDict()
else:
self.id_lang = 'en'
self.trans_dict = {}
self.Preferences.set('id_lang', self.id_lang)
def translate(self, text, *params):
trans_text = self.trans_dict.get(text, text)
for seq, param in enumerate(params):
seq_text = '{%d}' % seq
trans_text = trans_text.replace(seq_text, str(param))
return trans_text
def getLangId(self):
return self.id_lang
def getLangIds(self):
return self.ids_lang
def getLangNames(self, lang_id):
return self.lang_params.get(lang_id, ['Unknown', 'Unknown'])
class I18n(object):
def __init__(self):
self.lang_params = {}
self.ids_lang = []
self.id_path_dict = {}
self.trans_dict = {}
self.listIds()
self.Preferences = Preferences()
self.id_lang = self.Preferences.get('id_lang', Tools.getSystemLang())
self.changeLang(self.id_lang)
def listIds(self):
language_list_path = Paths.getLanguageList()
self.lang_params = JSONFile(language_list_path).getData()
language_path = Paths.getLanguagePath()
lang_file_paths = glob.glob(language_path + '/*.lang')
lang_file_names = [os.path.basename(p) for p in lang_file_paths]
self.ids_lang += [os.path.splitext(nam)[0] for nam in lang_file_names]
self.id_path_dict.update(dict(zip(self.ids_lang, lang_file_paths)))
self.ids_lang.sort(key=lambda _id: self.lang_params.get(_id)[1])
def changeLang(self, lang_id):
self.id_lang = lang_id if (lang_id in self.id_path_dict) else 'en'
lang_file_path = self.id_path_dict[self.id_lang]
lang_file = LanguageFile(lang_file_path)
self.trans_dict = lang_file.getTransDict()
self.Preferences.set('id_lang', self.id_lang)
def translate(self, text, *params):
trans_text = self.trans_dict.get(text, text)
for seq, param in enumerate(params):
seq_text = '{%d}' % seq
trans_text = trans_text.replace(seq_text, str(param))
return trans_text
def getLangId(self):
return self.id_lang
def getLangIds(self):
return self.ids_lang
def getLangNames(self, lang_id):
return self.lang_params.get(lang_id, ['Unknown', 'Unknown'])
class PioInstall(object):
def __init__(self):
self.Preferences = Preferences()
self.base_dir = Paths.getDeviotUserPath()
self.env_dir = Paths.getEnvDir()
self.env_bin_dir = Paths.getEnvBinDir()
self.cache_dir = Paths.getCacheDir()
self.env_file = Paths.getEnvFile()
self.cached_file = False
# console
window = sublime.active_window()
console_name = 'Deviot|Pio_Install' + str(time.time())
console = Messages.Console(window, name=console_name)
# Queue for the user console
self.message_queue = Messages.MessageQueue(console)
def checkPio(self):
# defining default env paths
os.environ['PATH'] = self.getEnvPaths()
# checking python
cmd = ['python', '--version']
out = childProcess(cmd)
# show error and link to download
if(out[0] > 0):
current_time = time.strftime('%H:%M:%S')
go_to = sublime.ok_cancel_dialog(
"deviot_need_python", "button_download_python")
if(go_to):
sublime.run_command(
'open_url', {'url': 'https://www.python.org/downloads/'})
return
# check if pio is installed
self.message_queue.startPrint()
self.message_queue.put("deviot_setup{0}", version)
current_time = time.strftime('%H:%M:%S')
cmd = ['pio', '--version']
out = childProcess(cmd)
if(out[0] == 0):
current_time = time.strftime('%H:%M:%S')
self.message_queue.put("pio_is_installed{0}", current_time)
self.endSetup()
return
current_time = time.strftime('%H:%M:%S')
self.message_queue.put("pio_isn_installed{0}", current_time)
# check if virtualenv file is cached
if(os.path.exists(self.env_file)):
self.cached_file = True
# download virtualenv
if(not self.cached_file):
current_time = time.strftime('%H:%M:%S')
self.message_queue.put("downloading_files{0}", current_time)
headers = Tools.getHeaders()
url_file = 'https://pypi.python.org/packages/source/v/virtualenv/virtualenv-14.0.1.tar.gz'
try:
file_request = Request(url_file, headers=headers)
file_open = urlopen(file_request)
file = file_open.read()
except:
current_time = time.strftime('%H:%M:%S')
self.message_queue.put(
"error_downloading_files{0}", current_time)
print("There was an error downloading virtualenv")
return
# save file
try:
output = open(self.env_file, 'wb')
output.write(bytearray(file))
output.close()
except:
current_time = time.strftime('%H:%M:%S')
self.message_queue.put("error_saving_files{0}", current_time)
print("There was an error saving the virtualenv file")
return
# extract file
current_time = time.strftime('%H:%M:%S')
self.message_queue.put("extracting_files{0}", current_time)
tmp = tempfile.mkdtemp()
Tools.extractTar(self.env_file, tmp)
# install virtualenv in a temp dir
current_time = time.strftime('%H:%M:%S')
self.message_queue.put("installing_pio{0}", current_time)
temp_env = os.path.join(tmp, 'env-root')
cwd = os.path.join(tmp, 'virtualenv-14.0.1')
cmd = ['python', 'setup.py', 'install', '--root', temp_env]
out = childProcess(cmd, cwd)
# error
if(out[0] > 0):
current_time = time.strftime('%H:%M:%S')
self.message_queue.put("error_installing_env_{0}", current_time)
return
# make vitualenv
for root, dirs, files in os.walk(tmp):
for file in files:
if(file == 'virtualenv.py'):
cwd = root
if(os.path.exists(cwd)):
cmd = ['python', 'virtualenv.py', '\"' + self.env_dir + '\"']
out = childProcess(cmd, cwd)
# error
if(out[0] > 0):
current_time = time.strftime('%H:%M:%S')
self.message_queue.put("error_making_env_{0}", current_time)
return
# remove temp dir
rmtree(tmp)
# install pio
executable = os.path.join(self.env_bin_dir, 'pip')
cmd = ['\"' + executable + '\"', 'install', 'platformio']
out = childProcess(cmd)
# error
if(out[0] > 0):
current_time = time.strftime('%H:%M:%S')
self.message_queue.put("error_installing_pio_{0}", current_time)
return
self.endSetup()
current_time = time.strftime('%H:%M:%S')
self.message_queue.put("setup_finished{0}", current_time)
def getEnvPaths(self):
# default paths
default_paths = Tools.getDefaultPaths()
system_paths = os.environ.get("PATH", "").split(os.path.pathsep)
env_paths = []
env_paths.extend(default_paths)
env_paths.extend(system_paths)
env_paths = list(OrderedDict.fromkeys(env_paths))
env_paths = os.path.pathsep.join(env_paths)
return env_paths
def saveEnvPaths(self, new_path):
env_paths = self.getEnvPaths().split(os.path.pathsep)
paths = []
paths.extend(new_path)
paths.extend(env_paths)
paths = list(OrderedDict.fromkeys(paths))
paths = os.path.pathsep.join(paths)
self.Preferences.set('env_path', paths)
self.Preferences.set('protected', True)
self.Preferences.set('enable_menu', True)
def endSetup(self):
# get pio version
executable = os.path.join(self.env_bin_dir, 'pio')
cmd = ['\"' + executable + '\"', '--version']
out = childProcess(cmd)
pio_version = match(r"\w+\W \w+ (.+)", out[1]).group(1)
self.Preferences.set('pio_version', pio_version)
# save env paths
env_path = [self.env_bin_dir]
self.saveEnvPaths(env_path)
# copy menu
sys_os = Tools.getOsName()
preset_path = Paths.getPresetPath()
plg_path = Paths.getPluginPath()
dst = os.path.join(plg_path, 'Settings-Default', 'Main.sublime-menu')
if(sys_os == 'windows'):
src_path = os.path.join(preset_path, 'Main.sublime-menu.windows')
copy(src_path, dst)
elif(sys_os == 'osx'):
src_path = os.path.join(preset_path, 'Main.sublime-menu.osx')
copy(src_path, dst)
else:
src_path = os.path.join(preset_path, 'Main.sublime-menu.linux')
copy(src_path, dst)
# creating files (menu, completions, syntax)
generateFiles()
class PlatformioCLI(CommandsPy):
'''
This class handle all the request to the platformio ecosystem.
From the list of boards to the build/upload of the sketchs.
More info about platformio in: http://platformio.org/
Extends: CommandsPy
'''
def __init__(self, view=False, console=False, install=False, command=True):
'''
Initialize the command and preferences classes, to check
if the current work file is an IoT type it received the view
parameter (ST parameter). This parameter is necessary only in
the options like build or upload.
Keyword Arguments:
view {st object} -- stores many info related with ST (default: False)
'''
self.Preferences = Preferences()
self.Menu = Menu()
# user console
if(console):
current_time = time.strftime('%H:%M:%S')
self.message_queue = MessageQueue(console)
self.message_queue.startPrint()
# For installing purposes
if(install):
self.Commands = CommandsPy(console=console)
return
self.view = view
self.execute = True
self.is_native = False
self.is_iot = False
if(view):
# avoid to do anything with a monitor view
view_name = view.name()
sketch_size = view.size()
file_path = Tools.getPathFromView(view)
if(not file_path and 'monitor' in view_name.lower()):
try:
current_time = time.strftime('%H:%M:%S')
self.message_queue.put('invalid_file_{0}', current_time)
except:
pass
self.execute = False
return
# unsaved file
if(command and not file_path and sketch_size > 0):
saved_file = self.saveCodeInFile(view)
view = saved_file[1]
file_path = Tools.getPathFromView(view)
if(command and not sketch_size):
self.message_queue.put('not_empty_sketch_{0}', current_time)
# current file / view
current_path = Paths.getCurrentFilePath(view)
if(not current_path):
return
self.is_iot = Tools.isIOTFile(view)
current_dir = Paths.getCWD(current_path)
parent_dir = Paths.getParentCWD(current_path)
file_name = Tools.getFileNameFromPath(file_path)
temp_name = Tools.getFileNameFromPath(current_path, ext=False)
if(not self.is_iot):
self.execute = False
# check IoT type file
if(console and not self.is_iot and not self.execute):
current_time = time.strftime('%H:%M:%S')
msg = 'not_iot_{0}{1}'
if(not file_name):
msg = 'not_empty_sketch_{0}'
self.message_queue.put(msg, current_time, file_name)
self.execute = False
return
if(not command and not self.is_iot):
return
# Check native project
for file in os.listdir(parent_dir):
if(file.endswith('platformio.ini')):
self.dir = parent_dir
self.src = False
self.is_native = True
break
# set native paths
if(not self.is_native):
build_dir = self.Preferences.get('build_dir', False)
if(not build_dir):
build_dir = Paths.getTempPath(temp_name)
self.src = current_dir
self.dir = build_dir
# unsaved changes
if (command and view.is_dirty()):
view.run_command('save')
if(console):
self.message_queue.put(
'[ Deviot {0} ] {1}\\n', version, file_name)
time.sleep(0.02)
# Initilized commands
self.Commands = CommandsPy(console=console, cwd=self.dir)
def checkInitFile(self):
"""
Check each platformio.ini file and loads the environments already
initialized.
"""
protected = self.Preferences.get('protected', False)
if(not protected):
return
# Empy menu if it's not a IoT file
if(not self.is_iot):
if(Tools.getPythonVersion() > 2):
self.Menu.createEnvironmentMenu(empty=True)
return
ini_path = Paths.getFullIniPath(self.dir)
# show non native data
if(not self.is_native):
self.Preferences.set('native', False)
self.Preferences.set('ini_path', self.dir)
self.Menu.createEnvironmentMenu()
return
else:
self.Preferences.set('native', True)
self.Preferences.set('ini_path', self.dir)
# get data from platformio.ini file
ini_list = []
with open(ini_path, 'r') as file:
pattern = compile(r'\[(\w+)\W(\w+)\]')
for line in file:
if pattern.findall(line):
if('#' not in line):
line = match(r"\[\w+:(\w+)\]", line).group(1)
ini_list.append(line)
# save preferences, update menu data
type = 'board_id' if not self.is_native else 'found_ini'
self.Preferences.set(type, ini_list)
self.Menu.createEnvironmentMenu()
def removeEnvFromFile(self, env):
"""
Removes the environment select from the platformio.ini file
Arguments:
env {string} -- environment to remove
"""
ini_path = self.Preferences.get('ini_path', False)
if(not ini_path):
return
found = False
write = False
buffer = ""
# exclude environment selected
ini_path = Paths.getFullIniPath(ini_path)
if(not os.path.isfile(ini_path)):
return
with open(ini_path) as file:
for line in file:
if(env in line and not found):
found = True
write = True
if(not found):
buffer += line
if(found and line == '\n'):
found = False
# save new platformio.ini
if(write):
with open(ini_path, 'w') as file:
file.write(buffer)
def overrideSrc(self, ini_path, src_dir):
"""
Append in the platformio.ini file, the src_dir option
to override the source folder where the sketch is stored
Arguments:
ini_path {string} -- path of the platformio.ini file
src_dir {string} -- path where source folder the is located
"""
header = '[platformio]'
ini_path = Paths.getFullIniPath(self.dir)
with open(ini_path) as file:
if header not in file.read():
with open(ini_path, 'a+') as new_file:
new_file.write("\n%s\n" % header)
new_file.write("src_dir=%s\n" % src_dir)
def initSketchProject(self, chosen):
'''
command to initialize the board(s) selected by the user. This
function can only be use if the workig file is an IoT type
(checked by isIOTFile)
'''
# check if it was already initialized
ini_path = Paths.getFullIniPath(self.dir)
if(os.path.isfile(ini_path)):
with open(ini_path) as file:
if(chosen in file.read()):
return
init_board = '--board=%s ' % chosen
if(not init_board):
current_time = time.strftime('%H:%M:%S')
msg = 'none_board_sel_{0}'
self.message_queue.put(msg, current_time)
self.Commands.error_running = True
return
command = ['init', '%s' % (init_board)]
self.Commands.runCommand(command)
if(not self.Commands.error_running):
if(self.is_native):
self.Preferences.set('init_queue', '')
if(not self.is_native and self.src):
self.overrideSrc(self.dir, self.src)
def buildSketchProject(self):
'''
Command to build the current working sketch, it must to be IoT
type (checked by isIOTFile)
'''
if(not self.execute):
self.message_queue.stopPrint()
return
# get environment based on the current project
type = 'env_selected' if not self.is_native else 'native_env_selected'
choosen_env = self.Preferences.get(type, '')
if(type == 'native_env_selected' and not choosen_env):
choosen_env = self.Preferences.get('init_queue', '')
# check environment selected
if(not choosen_env):
current_time = time.strftime('%H:%M:%S')
self.message_queue.put('none_env_select_{0}', current_time)
return False
# initialize the sketch
self.initSketchProject(choosen_env)
if(self.Commands.error_running):
self.message_queue.stopPrint()
return
command = ['run', '-e %s' % choosen_env]
self.Commands.runCommand(command)
# set build sketch
if(not self.Commands.error_running):
self.Preferences.set('builded_sketch', True)
return choosen_env
else:
self.Preferences.set('builded_sketch', False)
def uploadSketchProject(self):
'''
Upload the sketch to the select board to the select COM port
it returns an error if any com port is selected
'''
if(not self.execute):
self.message_queue.stopPrint()
return
# Stop serial monitor
Tools.closeSerialMonitors(self.Preferences)
# Compiling code
choosen_env = self.buildSketchProject()
if(not choosen_env):
return
if(self.Commands.error_running):
self.message_queue.stopPrint()
return
id_port = self.Preferences.get('id_port', '')
current_ports = listSerialPorts()
if(id_port not in current_ports):
id_port = False
# check port selected
if(not id_port):
current_time = time.strftime('%H:%M:%S')
self.message_queue.put('none_port_select_{0}', current_time)
return
command = ['run', '-t upload --upload-port %s -e %s' %
(id_port, choosen_env)]
self.Commands.runCommand(command)
if(not self.Commands.error_running):
autorun = self.Preferences.get('autorun_monitor', False)
if(autorun):
Tools.toggleSerialMonitor()
self.Preferences.set('autorun_monitor', False)
self.message_queue.stopPrint()
def cleanSketchProject(self):
'''
Delete compiled object files, libraries and firmware/program binaries
if a sketch has been built previously
'''
if(not self.execute):
return
builded_sketch = self.Preferences.get('builded_sketch', '')
if(not builded_sketch):
return
command = ['run', '-t clean']
self.Commands.runCommand(command)
if(not self.Commands.error_running):
self.Preferences.set('builded_sketch', False)
self.message_queue.stopPrint()
def upgradePio(self):
self.message_queue.put('[ Deviot {0} ]\\n', version)
self.message_queue.put('searching_pio_updates', version)
command = ['upgrade']
self.Commands.runCommand(command, verbose=True)
command = ['--version']
out = self.Commands.runCommand(command, verbose=True, setReturn=True)
if(out):
pio_version = match(r"\w+\W \w+ (.+)", out).group(1)
self.Preferences.set('pio_version', pio_version)
self.saveAPIBoards()
self.Menu.createMainMenu()
def openInThread(self, type, chosen=False):
"""
Opens each action; build/upload/clean in a new thread
Arguments: type {string} -- type of action.
Valid values: build/upload/clean
"""
if(type == 'init'):
action_thread = threading.Thread(
target=self.initSketchProject, args=(chosen,))
action_thread.start()
elif(type == 'build'):
action_thread = threading.Thread(target=self.buildSketchProject)
action_thread.start()
elif (type == 'upload'):
action_thread = threading.Thread(target=self.uploadSketchProject)
action_thread.start()
elif(type == 'upgrade'):
action_thread = threading.Thread(target=self.upgradePio)
action_thread.start()
else:
action_thread = threading.Thread(target=self.cleanSketchProject)
action_thread.start()
ThreadProgress(action_thread, _('processing'), _('done'))
def saveCodeInFile(self, view):
"""
If the sketch in the current view has been not saved, it generate
a random name and stores in a temp folder.
Arguments: view {ST Object} -- Object with multiples options of ST
"""
ext = '.ino'
tmp_path = Paths.getTempPath()
file_name = str(time.time()).split('.')[0]
file_path = os.path.join(tmp_path, file_name)
file_path = os.path.join(file_path, 'src')
os.makedirs(file_path)
full_path = file_name + ext
full_path = os.path.join(file_path, full_path)
region = sublime.Region(0, view.size())
text = view.substr(region)
file = JSONFile(full_path)
file.writeFile(text)
view.set_scratch(True)
window = view.window()
window.run_command('close')
view = window.open_file(full_path)
return (True, view)
def getAPIBoards(self):
'''
Get the list of boards from platformIO API using CLI.
To know more info about platformIO visit: http://www.platformio.org/
Returns: {json object} -- list with all boards in a JSON format
'''
window = sublime.active_window()
view = window.active_view()
Tools.setStatus(view, _('updating_board_list'))
boards = []
Run = CommandsPy()
command = ['boards', '--json-output']
boards = Run.runCommand(command, setReturn=True)
Tools.setStatus(view, _('Done'), erase_time=4000)
return boards
def saveAPIBoards(self, update_method=False):
'''
Save the JSON object in a specific JSON file
'''
boards = self.getAPIBoards()
self.Menu.saveTemplateMenu(
data=boards, file_name='platformio_boards.json', user_path=True)
self.saveEnvironmentFile()
if(update_method):
update_method()
def saveEnvironmentFile(self):
'''
Load the JSON file with the list of all boards and re order it
based on the vendor. after that format the data to operate with
the standards required for the ST
Returns: {json array} -- list of all boards to show in the menu
'''
boards_list = []
platformio_data = self.Menu.getTemplateMenu(
file_name='platformio_boards.json', user_path=True)
if(not platformio_data):
return
platformio_data = json.loads(platformio_data)
for datakey, datavalue in platformio_data.items():
# children
children = {}
children['caption'] = datavalue['name']
children['command'] = 'select_env'
children['checkbox'] = True
children['args'] = {'board_id': datakey}
# Board List
temp_info = {}
temp_info[datakey] = {'children': []}
temp_info[datakey]['children'].append(children)
boards_list.append(temp_info)
# Save board list
self.Menu.saveTemplateMenu(
boards_list, 'env_boards.json', user_path=True)
class Libraries:
"""
Handle the library API from platformIO
More info: http://docs.platformio.org/en/latest/librarymanager/index.html
"""
def __init__(self, window=None, view=None):
self.view = view
self.window = window
self.Preferences = Preferences()
# create window and view if not exists
if self.window is None:
self.window = sublime.active_window()
self.view = self.window.active_view()
# console
console_name = 'Deviot|Library' + str(time.time())
console = Messages.Console(self.window, name=console_name)
# Queue for the user console
self.message_queue = MessageQueue(console)
# CLI
self.Commands = CommandsPy(console=console)
def downloadList(self, keyword):
"""
Search a library in the platformio API api.platformio.org
the data of all pages are stored in a json file. The result
of the search is showing in the st quick panel
Arguments:
keyword {string}:
Keyword to search the library in the platformio API
"""
# building query
request = {}
request['query'] = keyword
query = urlencode(request)
# request parameters
url = 'http://api.platformio.org/lib/search?'
user_agent = 'Deviot/' + str(version) + \
' (Sublime-Text/' + str(sublime.version()) + ')'
headers = {'User-Agent': user_agent}
req = Request(url + query, headers=headers)
# receive first page
response = urlopen(req)
list = json.loads(response.read().decode())
# check number of pages
nloop = list['total'] / list['perpage']
if(nloop > 1):
# next pages
nloop = int(nloop) + 1 if nloop > int(nloop) else nloop
for page in range(2, nloop + 1):
# building query of next pages
request['page'] = page
query = urlencode(request)
req = Request(url + query, headers=headers)
# receive first page
response = urlopen(req)
page_next = json.loads(response.read().decode())
for item_next in page_next['items']:
list['items'].append(item_next)
# save data in file
self.saveLibraryData(list, 'default_list.json')
# show result in the quick panel
sublime.set_timeout(self.show_results, 0)
def show_results(self):
self.window.run_command('show_results')
def getList(self):
"""
Gets the list with all libraries found and returns
on the quick panel
Returns:
[dict] -- dictionary with all libraries found
"""
# get file
list = self.getLibrary('default_list.json')
list_ins = self.Preferences.get('user_libraries', '')
# if none result
if(list['total'] == 0):
list = [_('none_lib_found')]
return list
# arrange list to the quickpanel
quick_list = []
for item in list['items']:
if(str(item['id']) + ' ' not in " ".join(list_ins) + ' '):
item_list = []
item_list.append(item['name'])
item_list.append(item['description'])
item_list.append(str(item['id']))
quick_list.append(item_list)
# save and return data
self.saveLibraryData(quick_list, 'quick_list.json')
return quick_list
def installLibrary(self, selected):
"""
Install the selected library
Arguments:
selected {int}
position in dict of the library selected
"""
list = self.getLibrary('quick_list.json')
lib_id = list[selected][2]
lib_name = list[selected][0]
self.message_queue.startPrint()
self.message_queue.put('[ Deviot {0} ]\\n', version)
time.sleep(0.01)
# Install Library with CLI
command = ['lib', 'install', lib_id]
self.Commands.runCommand(command, extra_message=lib_name)
# update list of libraries installed in the preference file
self.getInstalledList(ids=True)
# update menu
Tools.updateMenuLibs()
def installedList(self):
"""
Show the installed libraries.
Returns:
[dict] -- dictionary with the data to show in the quick panel
"""
list = self.getLibrary('quick_list.json')
return list
def getInstalledList(self, ids=False):
"""
Run the CLI command to get the list of library(ies) installed,
stores the data in a json file and run a command to show the
quick panel with all the data founded
"""
command = ['lib', 'list', '--json-output']
Commands = CommandsPy()
output = Commands.runCommand(command, setReturn=True)
output = json.loads(output)
# return a dict with the ids of the installed libraries
if(ids):
installed_ids = []
if(output):
for item in output:
installed_ids.append(str(item['id']))
self.Preferences.set('user_libraries', installed_ids)
return
# arrange list to the quickpanel
quick_list = []
if(output):
for item in output:
item_list = []
item_list.append(item['name'])
item_list.append(item['description'])
item_list.append(str(item['id']))
quick_list.append(item_list)
else:
quick_list = [_('none_lib_installed')]
# save the data and run the quick panel
self.saveLibraryData(quick_list, 'quick_list.json')
self.window.run_command('show_remove_list')
def removeLibrary(self, selected):
"""
Run a CLI command with the ID of the library to uninstall,
also remove the reference of the ID in the preferences file.
Arguments:
selected {int}
position of the option selected in the quick panel.
"""
list = self.getLibrary('quick_list.json')
lib_id = list[selected][2]
lib_name = list[selected][0]
self.message_queue.startPrint()
self.message_queue.put('[ Deviot {0} ]\\n', version)
time.sleep(0.01)
# uninstall Library with CLI
command = ['lib', 'uninstall', lib_id]
self.Commands.runCommand(command, extra_message=lib_name)
# remove from preferences
if (not self.Commands.error_running):
installed = self.Preferences.get('user_libraries', '')
if(installed):
if(lib_id in installed):
self.Preferences.data.setdefault(
'user_libraries', []).remove(lib_id)
self.Preferences.saveData()
# update menu
Tools.updateMenuLibs()
def saveLibraryData(self, data, file_name):
"""
Stores the data of the libraries in a json file
Arguments:
data {json}
json data with the libraries
file_name {string}
name of the json file
"""
libraries_path = Paths.getLibraryPath()
library_path = os.path.join(libraries_path, file_name)
libraries = JSONFile(library_path)
libraries.setData(data)
libraries.saveData()
def getLibrary(self, file_name):
"""
Get a specific json file and return the data
Arguments:
file_name {string}
Json file name where is stored the library data
Returns:
[dict] -- Dictionary with the library data
"""
plugin_path = Paths.getLibraryPath()
library_path = os.path.join(plugin_path, file_name)
libraries = JSONFile(library_path).getData()
return libraries
class Libraries:
"""
Handle the library API from platformIO
More info: http://docs.platformio.org/en/latest/librarymanager/index.html
"""
def __init__(self, window=None, view=None):
self.view = view
self.window = window
self.Preferences = Preferences()
# create window and view if not exists
if self.window is None:
self.window = sublime.active_window()
self.view = self.window.active_view()
# console
console_name = 'Deviot|Library' + str(time.time())
console = Messages.Console(self.window, name=console_name)
# Queue for the user console
self.message_queue = MessageQueue(console)
# CLI
self.Commands = CommandsPy(console=console)
def downloadList(self, keyword):
"""
Search a library in the platformio API api.platformio.org
the data of all pages are stored in a json file. The result
of the search is showing in the st quick panel
Arguments:
keyword {string}:
Keyword to search the library in the platformio API
"""
# building query
request = {}
request['query'] = keyword
query = urlencode(request)
# request parameters
url = 'http://api.platformio.org/lib/search?'
user_agent = 'Deviot/' + str(version) + \
' (Sublime-Text/' + str(sublime.version()) + ')'
headers = {'User-Agent': user_agent}
req = Request(url + query, headers=headers)
# receive first page
response = urlopen(req)
list = json.loads(response.read().decode())
# check number of pages
nloop = list['total'] / list['perpage']
if (nloop > 1):
# next pages
nloop = int(nloop) + 1 if nloop > int(nloop) else nloop
for page in range(2, nloop + 1):
# building query of next pages
request['page'] = page
query = urlencode(request)
req = Request(url + query, headers=headers)
# receive first page
response = urlopen(req)
page_next = json.loads(response.read().decode())
for item_next in page_next['items']:
list['items'].append(item_next)
# save data in file
self.saveLibraryData(list, 'default_list.json')
# show result in the quick panel
sublime.set_timeout(self.show_results, 0)
def show_results(self):
self.window.run_command('show_results')
def getList(self):
"""
Gets the list with all libraries found and returns
on the quick panel
Returns:
[dict] -- dictionary with all libraries found
"""
# get file
list = self.getLibrary('default_list.json')
list_ins = self.Preferences.get('user_libraries', '')
# if none result
if (list['total'] == 0):
list = [_('none_lib_found')]
return list
# arrange list to the quickpanel
quick_list = []
for item in list['items']:
if (str(item['id']) + ' ' not in " ".join(list_ins) + ' '):
item_list = []
item_list.append(item['name'])
item_list.append(item['description'])
item_list.append(str(item['id']))
quick_list.append(item_list)
# save and return data
self.saveLibraryData(quick_list, 'quick_list.json')
return quick_list
def installLibrary(self, selected):
"""
Install the selected library
Arguments:
selected {int}
position in dict of the library selected
"""
list = self.getLibrary('quick_list.json')
lib_id = list[selected][2]
lib_name = list[selected][0]
self.message_queue.startPrint()
self.message_queue.put('[ Deviot {0} ]\\n', version)
time.sleep(0.01)
# Install Library with CLI
command = ['lib', 'install', lib_id]
self.Commands.runCommand(command, extra_message=lib_name)
# update list of libraries installed in the preference file
self.getInstalledList(ids=True)
# update menu
Tools.updateMenuLibs()
def installedList(self):
"""
Show the installed libraries.
Returns:
[dict] -- dictionary with the data to show in the quick panel
"""
list = self.getLibrary('quick_list.json')
return list
def getInstalledList(self, ids=False):
"""
Run the CLI command to get the list of library(ies) installed,
stores the data in a json file and run a command to show the
quick panel with all the data founded
"""
command = ['lib', 'list', '--json-output']
Commands = CommandsPy()
output = Commands.runCommand(command, setReturn=True)
output = json.loads(output)
# return a dict with the ids of the installed libraries
if (ids):
installed_ids = []
if (output):
for item in output:
installed_ids.append(str(item['id']))
self.Preferences.set('user_libraries', installed_ids)
return
# arrange list to the quickpanel
quick_list = []
if (output):
for item in output:
item_list = []
item_list.append(item['name'])
item_list.append(item['description'])
item_list.append(str(item['id']))
quick_list.append(item_list)
else:
quick_list = [_('none_lib_installed')]
# save the data and run the quick panel
self.saveLibraryData(quick_list, 'quick_list.json')
self.window.run_command('show_remove_list')
def removeLibrary(self, selected):
"""
Run a CLI command with the ID of the library to uninstall,
also remove the reference of the ID in the preferences file.
Arguments:
selected {int}
position of the option selected in the quick panel.
"""
list = self.getLibrary('quick_list.json')
lib_id = list[selected][2]
lib_name = list[selected][0]
self.message_queue.startPrint()
self.message_queue.put('[ Deviot {0} ]\\n', version)
time.sleep(0.01)
# uninstall Library with CLI
command = ['lib', 'uninstall', lib_id]
self.Commands.runCommand(command, extra_message=lib_name)
# remove from preferences
if (not self.Commands.error_running):
installed = self.Preferences.get('user_libraries', '')
if (installed):
if (lib_id in installed):
self.Preferences.data.setdefault('user_libraries',
[]).remove(lib_id)
self.Preferences.saveData()
# update menu
Tools.updateMenuLibs()
def saveLibraryData(self, data, file_name):
"""
Stores the data of the libraries in a json file
Arguments:
data {json}
json data with the libraries
file_name {string}
name of the json file
"""
libraries_path = Paths.getLibraryPath()
library_path = os.path.join(libraries_path, file_name)
libraries = JSONFile(library_path)
libraries.setData(data)
libraries.saveData()
def getLibrary(self, file_name):
"""
Get a specific json file and return the data
Arguments:
file_name {string}
Json file name where is stored the library data
Returns:
[dict] -- Dictionary with the library data
"""
plugin_path = Paths.getLibraryPath()
library_path = os.path.join(plugin_path, file_name)
libraries = JSONFile(library_path).getData()
return libraries
class PlatformioCLI(CommandsPy):
'''
This class handle all the request to the platformio ecosystem.
From the list of boards to the build/upload of the sketchs.
More info about platformio in: http://platformio.org/
Extends: CommandsPy
'''
def __init__(self, view=False, console=False, install=False, command=True):
'''
Initialize the command and preferences classes, to check
if the current work file is an IoT type it received the view
parameter (ST parameter). This parameter is necessary only in
the options like build or upload.
Keyword Arguments:
view {st object} -- stores many info related with ST (default: False)
'''
self.Preferences = Preferences()
self.Menu = Menu()
# user console
if (console):
current_time = time.strftime('%H:%M:%S')
self.message_queue = MessageQueue(console)
self.message_queue.startPrint()
# For installing purposes
if (install):
self.Commands = CommandsPy(console=console)
return
self.view = view
self.execute = True
self.is_native = False
self.is_iot = False
if (view):
# avoid to do anything with a monitor view
view_name = view.name()
sketch_size = view.size()
file_path = Tools.getPathFromView(view)
if (not file_path and 'monitor' in view_name.lower()):
try:
current_time = time.strftime('%H:%M:%S')
self.message_queue.put('invalid_file_{0}', current_time)
except:
pass
self.execute = False
return
# unsaved file
if (command and not file_path and sketch_size > 0):
saved_file = self.saveCodeInFile(view)
view = saved_file[1]
file_path = Tools.getPathFromView(view)
if (command and not sketch_size):
self.message_queue.put('not_empty_sketch_{0}', current_time)
# current file / view
current_path = Paths.getCurrentFilePath(view)
if (not current_path):
return
self.is_iot = Tools.isIOTFile(view)
current_dir = Paths.getCWD(current_path)
parent_dir = Paths.getParentCWD(current_path)
file_name = Tools.getFileNameFromPath(file_path)
temp_name = Tools.getFileNameFromPath(current_path, ext=False)
if (not self.is_iot):
self.execute = False
# check IoT type file
if (console and not self.is_iot and not self.execute):
current_time = time.strftime('%H:%M:%S')
msg = 'not_iot_{0}{1}'
if (not file_name):
msg = 'not_empty_sketch_{0}'
self.message_queue.put(msg, current_time, file_name)
self.execute = False
return
if (not command and not self.is_iot):
return
# Check native project
for file in os.listdir(parent_dir):
if (file.endswith('platformio.ini')):
self.dir = parent_dir
self.src = False
self.is_native = True
break
# set native paths
if (not self.is_native):
build_dir = Paths.getBuildPath(temp_name)
if (not build_dir):
build_dir = Paths.getTempPath(temp_name)
self.src = current_dir
self.dir = build_dir
# unsaved changes
if (command and view.is_dirty()):
view.run_command('save')
if (console):
self.message_queue.put('[ Deviot {0} ] {1}\\n', version,
file_name)
time.sleep(0.02)
# Initilized commands
self.Commands = CommandsPy(console=console, cwd=self.dir)
def checkInitFile(self):
"""
Check each platformio.ini file and loads the environments already
initialized.
"""
protected = self.Preferences.get('protected', False)
if (not protected):
return
# Empy menu if it's not a IoT file
if (not self.is_iot):
return
ini_path = Paths.getFullIniPath(self.dir)
# show non native data
if (not self.is_native):
self.Preferences.set('native', False)
self.Preferences.set('ini_path', self.dir)
self.Menu.createEnvironmentMenu()
return
else:
self.Preferences.set('native', True)
self.Preferences.set('ini_path', self.dir)
# get data from platformio.ini file
ini_list = []
with open(ini_path, 'r') as file:
pattern = compile(r'\[(\w+)\W(\w+)\]')
for line in file:
if pattern.findall(line):
if ('#' not in line):
line = match(r"\[\w+:(\w+)\]", line).group(1)
ini_list.append(line)
# save preferences, update menu data
type = 'board_id' if not self.is_native else 'found_ini'
self.Preferences.set(type, ini_list)
self.Menu.createEnvironmentMenu()
def removeEnvFromFile(self, env):
"""
Removes the environment select from the platformio.ini file
Arguments:
env {string} -- environment to remove
"""
ini_path = self.Preferences.get('ini_path', False)
if (not ini_path):
return
found = False
write = False
buffer = ""
# exclude environment selected
ini_path = Paths.getFullIniPath(ini_path)
if (not os.path.isfile(ini_path)):
return
with open(ini_path) as file:
for line in file:
if (env in line and not found):
found = True
write = True
if (not found):
buffer += line
if (found and line == '\n'):
found = False
# save new platformio.ini
if (write):
with open(ini_path, 'w') as file:
file.write(buffer)
def overrideSrc(self, ini_path, src_dir):
"""
Append in the platformio.ini file, the src_dir option
to override the source folder where the sketch is stored
Arguments:
ini_path {string} -- path of the platformio.ini file
src_dir {string} -- path where source folder the is located
"""
header = '[platformio]'
ini_path = Paths.getFullIniPath(self.dir)
with open(ini_path) as file:
if header not in file.read():
with open(ini_path, 'a+') as new_file:
new_file.write("\n%s\n" % header)
new_file.write("src_dir=%s\n" % src_dir)
def initSketchProject(self, chosen):
'''
command to initialize the board(s) selected by the user. This
function can only be use if the workig file is an IoT type
(checked by isIOTFile)
'''
# check if it was already initialized
ini_path = Paths.getFullIniPath(self.dir)
if (os.path.isfile(ini_path)):
with open(ini_path) as file:
if (chosen in file.read()):
return
init_board = '--board=%s ' % chosen
if (not init_board):
current_time = time.strftime('%H:%M:%S')
msg = 'none_board_sel_{0}'
self.message_queue.put(msg, current_time)
self.Commands.error_running = True
return
command = ['init', '%s' % (init_board)]
self.Commands.runCommand(command)
if (not self.Commands.error_running):
if (self.is_native):
self.Preferences.set('init_queue', '')
if (not self.is_native and self.src):
self.overrideSrc(self.dir, self.src)
def buildSketchProject(self):
'''
Command to build the current working sketch, it must to be IoT
type (checked by isIOTFile)
'''
if (not self.execute):
self.message_queue.stopPrint()
return
# get environment based on the current project
type = 'env_selected' if not self.is_native else 'native_env_selected'
choosen_env = self.Preferences.get(type, '')
if (type == 'native_env_selected' and not choosen_env):
choosen_env = self.Preferences.get('init_queue', '')
# check environment selected
if (not choosen_env):
current_time = time.strftime('%H:%M:%S')
self.message_queue.put('none_env_select_{0}', current_time)
return False
# initialize the sketch
self.initSketchProject(choosen_env)
if (self.Commands.error_running):
self.message_queue.stopPrint()
return
command = ['run', '-e %s' % choosen_env]
self.Commands.runCommand(command)
# set build sketch
if (not self.Commands.error_running):
self.Preferences.set('builded_sketch', True)
return choosen_env
else:
self.Preferences.set('builded_sketch', False)
def uploadSketchProject(self):
'''
Upload the sketch to the select board to the select COM port
it returns an error if any com port is selected
'''
id_port = self.Preferences.get('id_port', '')
current_ports = listSerialPorts()
if (id_port not in current_ports and id_port != 'none'):
id_port = False
# check port selected
if (not id_port):
current_time = time.strftime('%H:%M:%S')
self.message_queue.put('none_port_select_{0}', current_time)
self.execute = False
if (not self.execute):
self.message_queue.stopPrint()
return
# Stop serial monitor
Tools.closeSerialMonitors(self.Preferences)
# Compiling code
choosen_env = self.buildSketchProject()
if (not choosen_env):
return
if (self.Commands.error_running):
self.message_queue.stopPrint()
return
up_port = '--upload-port %s' % id_port
if (id_port == 'none'):
up_port = ''
command = ['run', '-t upload %s -e %s' % (up_port, choosen_env)]
self.Commands.runCommand(command)
if (not self.Commands.error_running):
autorun = self.Preferences.get('autorun_monitor', False)
if (autorun):
Tools.toggleSerialMonitor()
self.Preferences.set('autorun_monitor', False)
self.message_queue.stopPrint()
def cleanSketchProject(self):
'''
Delete compiled object files, libraries and firmware/program binaries
if a sketch has been built previously
'''
if (not self.execute):
return
builded_sketch = self.Preferences.get('builded_sketch', '')
if (not builded_sketch):
return
command = ['run', '-t clean']
self.Commands.runCommand(command)
if (not self.Commands.error_running):
self.Preferences.set('builded_sketch', False)
self.message_queue.stopPrint()
def openInThread(self, type, chosen=False):
"""
Opens each action; build/upload/clean in a new thread
Arguments: type {string} -- type of action.
Valid values: build/upload/clean
"""
if (type == 'init'):
action_thread = threading.Thread(target=self.initSketchProject,
args=(chosen, ))
action_thread.start()
elif (type == 'build'):
action_thread = threading.Thread(target=self.buildSketchProject)
action_thread.start()
elif (type == 'upload'):
action_thread = threading.Thread(target=self.uploadSketchProject)
action_thread.start()
elif (type == 'upgrade'):
action_thread = threading.Thread(target=PioInstall().checkUpdate)
action_thread.start()
elif (type == 'update_boards'):
action_thread = threading.Thread(
target=PlatformioCLI().saveAPIBoards)
action_thread.start()
else:
action_thread = threading.Thread(target=self.cleanSketchProject)
action_thread.start()
ThreadProgress(action_thread, _('processing'), _('done'))
def saveCodeInFile(self, view):
"""
If the sketch in the current view has been not saved, it generate
a random name and stores in a temp folder.
Arguments: view {ST Object} -- Object with multiples options of ST
"""
ext = '.ino'
tmp_path = Paths.getTempPath()
file_name = str(time.time()).split('.')[0]
file_path = os.path.join(tmp_path, file_name)
file_path = os.path.join(file_path, 'src')
os.makedirs(file_path)
full_path = file_name + ext
full_path = os.path.join(file_path, full_path)
region = sublime.Region(0, view.size())
text = view.substr(region)
file = JSONFile(full_path)
file.writeFile(text)
view.set_scratch(True)
window = view.window()
window.run_command('close')
view = window.open_file(full_path)
return (True, view)
def getAPIBoards(self):
'''
Get the list of boards from platformIO API using CLI.
To know more info about platformIO visit: http://www.platformio.org/
Returns: {json object} -- list with all boards in a JSON format
'''
window = sublime.active_window()
view = window.active_view()
Tools.setStatus(view, _('updating_board_list'))
boards = []
Run = CommandsPy()
command = ['boards', '--json-output']
boards = Run.runCommand(command, setReturn=True)
Tools.setStatus(view, _('Done'), erase_time=4000)
return boards
def saveAPIBoards(self, update_method=False, install=False):
'''
Save the JSON object in a specific JSON file
'''
try:
from .Menu import Menu
except:
from libs.Menu import Menu
window = sublime.active_window()
view = window.active_view()
Tools.setStatus(view, _('updating_board_list'))
# console
if (not install):
console_name = 'Deviot|GetBoards' + str(time.time())
console = Console(window, name=console_name)
new_console = True
# Queue for the user console
message_queue = MessageQueue(console)
message_queue.startPrint()
message_queue.put("[Deviot {0}]\n", version)
message_queue.put("download_board_list")
boards = self.getAPIBoards()
self.Menu.saveTemplateMenu(data=boards,
file_name='platformio_boards.json',
user_path=True)
self.saveEnvironmentFile()
Menu().createMainMenu()
if (not install):
message_queue.put("list_updated")
def saveEnvironmentFile(self):
'''
Load the JSON file with the list of all boards and re order it
based on the vendor. after that format the data to operate with
the standards required for the ST
Returns: {json array} -- list of all boards to show in the menu
'''
boards_list = []
platformio_data = self.Menu.getTemplateMenu(
file_name='platformio_boards.json', user_path=True)
if (not platformio_data):
return
platformio_data = json.loads(platformio_data)
for datakey, datavalue in platformio_data.items():
# children
children = {}
children['caption'] = datavalue['name']
children['command'] = 'select_env'
children['checkbox'] = True
children['args'] = {'board_id': datakey}
# Board List
temp_info = {}
temp_info[datakey] = {'children': []}
temp_info[datakey]['children'].append(children)
boards_list.append(temp_info)
# Save board list
self.Menu.saveTemplateMenu(boards_list,
'env_boards.json',
user_path=True)